Google Git
Sign in
apache / airflow-site / f81e48aadee354653679693fa54b04ac42d24bfd / . / docs-archive / 1.10.4 / _modules / airflow / contrib / operators / sqoop_operator.html
blob: e85835f1c30e089a9de298143f7c6146b597b1a4 [file] [log] [blame]
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>airflow.contrib.operators.sqoop_operator &mdash; Airflow Documentation</title>
<script type="text/javascript" src="../../../../_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../../../../" src="../../../../_static/documentation_options.js"></script>
<script type="text/javascript" src="../../../../_static/jquery.js"></script>
<script type="text/javascript" src="../../../../_static/underscore.js"></script>
<script type="text/javascript" src="../../../../_static/doctools.js"></script>
<script type="text/javascript" src="../../../../_static/language_data.js"></script>
<script type="text/javascript" src="../../../../_static/js/theme.js"></script>
<link rel="stylesheet" href="../../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="../../../../genindex.html" />
<link rel="search" title="Search" href="../../../../search.html" />
<script>
document.addEventListener('DOMContentLoaded', function() {
var el = document.getElementById('changelog');
if (el !== null ) {
// [AIRFLOW-...]
el.innerHTML = el.innerHTML.replace(
/\[(AIRFLOW-[\d]+)\]/g,
`<a href="https://issues.apache.org/jira/browse/$1">[$1]</a>`
);
// (#...)
el.innerHTML = el.innerHTML.replace(
/\(#([\d]+)\)/g,
`<a href="https://github.com/apache/airflow/pull/$1">(#$1)</a>`
);
};
})
</script>
<style>
.example-header {
position: relative;
background: #9AAA7A;
padding: 8px 16px;
margin-bottom: 0;
}
.example-header--with-button {
padding-right: 166px;
}
.example-header:after{
content: '';
display: table;
clear: both;
}
.example-title {
display:block;
padding: 4px;
margin-right: 16px;
color: white;
overflow-x: auto;
}
.example-header-button {
top: 8px;
right: 16px;
position: absolute;
}
.example-header + .highlight-python {
margin-top: 0 !important;
}
.viewcode-button {
display: inline-block;
padding: 8px 16px;
border: 0;
margin: 0;
outline: 0;
border-radius: 2px;
-webkit-box-shadow: 0 3px 5px 0 rgba(0,0,0,.3);
box-shadow: 0 3px 6px 0 rgba(0,0,0,.3);
color: #404040;
background-color: #e7e7e7;
cursor: pointer;
font-size: 16px;
font-weight: 500;
line-height: 1;
text-decoration: none;
text-overflow: ellipsis;
overflow: hidden;
text-transform: uppercase;
-webkit-transition: background-color .2s;
transition: background-color .2s;
vertical-align: middle;
white-space: nowrap;
}
.viewcode-button:visited {
color: #404040;
}
.viewcode-button:hover, .viewcode-button:focus {
color: #404040;
background-color: #d6d6d6;
}
</style>
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../../../../index.html" class="icon icon-home"> Airflow
</a>
<div class="version">
1.10.4
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../../project.html">Project</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../license.html">License</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../start.html">Quick Start</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../tutorial.html">Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../howto/index.html">How-to Guides</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../ui.html">UI / Screenshots</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../concepts.html">Concepts</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../profiling.html">Data Profiling</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../cli.html">Command Line Interface</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../scheduler.html">Scheduling &amp; Triggers</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../plugins.html">Plugins</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../security.html">Security</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../timezone.html">Time zones</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../api.html">Experimental Rest API</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../integration.html">Integration</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../metrics.html">Metrics</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../kubernetes.html">Kubernetes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../lineage.html">Lineage</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../changelog.html">Changelog</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../faq.html">FAQ</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../macros.html">Macros reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../_api/index.html">API Reference</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../../../index.html">Airflow</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../../../index.html">Docs</a> &raquo;</li>
<li><a href="../../../index.html">Module code</a> &raquo;</li>
<li><a href="../operators.html">airflow.contrib.operators</a> &raquo;</li>
<li>airflow.contrib.operators.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"># &quot;License&quot;); you may not use this file except in compliance</span>
<span class="c1"># with the License. You may obtain a copy of the License at</span>
<span class="c1">#</span>
<span class="c1"># http://www.apache.org/licenses/LICENSE-2.0</span>
<span class="c1">#</span>
<span class="c1"># Unless required by applicable law or agreed to in writing,</span>
<span class="c1"># software distributed under the License is distributed on an</span>
<span class="c1"># &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span>
<span class="c1"># KIND, either express or implied. See the License for the</span>
<span class="c1"># specific language governing permissions and limitations</span>
<span class="c1"># under the License.</span>
<span class="c1">#</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd">This module contains a sqoop 1 operator</span>
<span class="sd">&quot;&quot;&quot;</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="../../../../_api/airflow/contrib/operators/sqoop_operator/index.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">&quot;&quot;&quot;</span>
<span class="sd"> Execute a Sqoop job.</span>
<span class="sd"> Documentation for Apache Sqoop can be found here:</span>
<span class="sd"> https://sqoop.apache.org/docs/1.4.2/SqoopUserGuide.html</span>
<span class="sd"> &quot;&quot;&quot;</span>
<div class="viewcode-block" id="SqoopOperator.template_fields"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/sqoop_operator/index.html#airflow.contrib.operators.sqoop_operator.SqoopOperator.template_fields">[docs]</a> <span class="n">template_fields</span> <span class="o">=</span> <span class="p">(</span><span class="s1">&#39;conn_id&#39;</span><span class="p">,</span> <span class="s1">&#39;cmd_type&#39;</span><span class="p">,</span> <span class="s1">&#39;table&#39;</span><span class="p">,</span> <span class="s1">&#39;query&#39;</span><span class="p">,</span> <span class="s1">&#39;target_dir&#39;</span><span class="p">,</span>
<span class="s1">&#39;file_type&#39;</span><span class="p">,</span> <span class="s1">&#39;columns&#39;</span><span class="p">,</span> <span class="s1">&#39;split_by&#39;</span><span class="p">,</span>
<span class="s1">&#39;where&#39;</span><span class="p">,</span> <span class="s1">&#39;export_dir&#39;</span><span class="p">,</span> <span class="s1">&#39;input_null_string&#39;</span><span class="p">,</span>
<span class="s1">&#39;input_null_non_string&#39;</span><span class="p">,</span> <span class="s1">&#39;staging_table&#39;</span><span class="p">,</span>
<span class="s1">&#39;enclosed_by&#39;</span><span class="p">,</span> <span class="s1">&#39;escaped_by&#39;</span><span class="p">,</span> <span class="s1">&#39;input_fields_terminated_by&#39;</span><span class="p">,</span>
<span class="s1">&#39;input_lines_terminated_by&#39;</span><span class="p">,</span> <span class="s1">&#39;input_optionally_enclosed_by&#39;</span><span class="p">,</span>
<span class="s1">&#39;properties&#39;</span><span class="p">,</span> <span class="s1">&#39;extra_import_options&#39;</span><span class="p">,</span> <span class="s1">&#39;driver&#39;</span><span class="p">,</span>
<span class="s1">&#39;extra_export_options&#39;</span><span class="p">,</span> <span class="s1">&#39;hcatalog_database&#39;</span><span class="p">,</span> <span class="s1">&#39;hcatalog_table&#39;</span><span class="p">,)</span></div>
<div class="viewcode-block" id="SqoopOperator.ui_color"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/sqoop_operator/index.html#airflow.contrib.operators.sqoop_operator.SqoopOperator.ui_color">[docs]</a> <span class="n">ui_color</span> <span class="o">=</span> <span class="s1">&#39;#7D8CA4&#39;</span></div>
<span class="nd">@apply_defaults</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
<span class="n">conn_id</span><span class="o">=</span><span class="s1">&#39;sqoop_default&#39;</span><span class="p">,</span>
<span class="n">cmd_type</span><span class="o">=</span><span class="s1">&#39;import&#39;</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">&#39;text&#39;</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">&quot;&quot;&quot;</span>
<span class="sd"> :param conn_id: str</span>
<span class="sd"> :param cmd_type: str specify command to execute &quot;export&quot; or &quot;import&quot;</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: &quot;avro&quot;, &quot;sequence&quot;, &quot;text&quot; Imports data to</span>
<span class="sd"> into the specified format. Defaults to text.</span>
<span class="sd"> :param columns: &lt;col,col,col&gt; 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</span>
<span class="sd"> 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&#39;t have a value, just pass an empty string to it.</span>
<span class="sd"> Don&#39;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&#39;t have a value, just pass an empty string to it.</span>
<span class="sd"> Don&#39;t include prefix of -- for sqoop options.</span>
<span class="sd"> &quot;&quot;&quot;</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="../../../../_api/airflow/contrib/operators/sqoop_operator/index.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">&quot;&quot;&quot;</span>
<span class="sd"> Execute sqoop job</span>
<span class="sd"> &quot;&quot;&quot;</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">&#39;export&#39;</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">&#39;import&#39;</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</span>
<span class="c1"># so don&#39;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">&#39;create-hcatalog-table&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;&#39;</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">&#39;Cannot specify query and table together. Need to specify either or.&#39;</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">&quot;Provide query or table parameter to import using Sqoop&quot;</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">&quot;cmd_type should be &#39;import&#39; or &#39;export&#39;&quot;</span><span class="p">)</span></div>
<div class="viewcode-block" id="SqoopOperator.on_kill"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/sqoop_operator/index.html#airflow.contrib.operators.sqoop_operator.SqoopOperator.on_kill">[docs]</a> <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">&#39;Sending SIGTERM signal to bash process group&#39;</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></div>
</pre></div>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>