Google Git
Sign in
apache / airflow-site / f81e48aadee354653679693fa54b04ac42d24bfd / . / docs-archive / 1.10.5 / _modules / airflow / hooks.html
blob: 0033d4d99b953f092fd1dd2ff4d51f60bd432411 [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.hooks &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>
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-140539454-1']);
_gaq.push(['_trackPageview']);
</script>
<style>
.example-header {
position: relative;
background: #9AAA7A;
padding: 8px 16px;
margin-bottom: 0;
}
.example-header--with-button {
padding-right: 166px;
}
.example-header:after{
content: '';
display: table;
clear: both;
}
.example-title {
display:block;
padding: 4px;
margin-right: 16px;
color: white;
overflow-x: auto;
}
.example-header-button {
top: 8px;
right: 16px;
position: absolute;
}
.example-header + .highlight-python {
margin-top: 0 !important;
}
.viewcode-button {
display: inline-block;
padding: 8px 16px;
border: 0;
margin: 0;
outline: 0;
border-radius: 2px;
-webkit-box-shadow: 0 3px 5px 0 rgba(0,0,0,.3);
box-shadow: 0 3px 6px 0 rgba(0,0,0,.3);
color: #404040;
background-color: #e7e7e7;
cursor: pointer;
font-size: 16px;
font-weight: 500;
line-height: 1;
text-decoration: none;
text-overflow: ellipsis;
overflow: hidden;
text-transform: uppercase;
-webkit-transition: background-color .2s;
transition: background-color .2s;
vertical-align: middle;
white-space: nowrap;
}
.viewcode-button:visited {
color: #404040;
}
.viewcode-button:hover, .viewcode-button:focus {
color: #404040;
background-color: #d6d6d6;
}
</style>
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../../index.html" class="icon icon-home"> Airflow
</a>
<div class="version">
1.10.5
</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 Reference</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">REST API Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../integration.html">Integration</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../metrics.html">Metrics</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../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">Python API Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../privacy_notice.html">Privacy Notice</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>airflow.hooks</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.hooks</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="kn">import</span> <span class="nn">os</span> <span class="k">as</span> <span class="nn">_os</span>
<span class="kn">import</span> <span class="nn">sys</span>
<span class="c1"># ------------------------------------------------------------------------</span>
<span class="c1">#</span>
<span class="c1"># #TODO #FIXME Airflow 2.0</span>
<span class="c1">#</span>
<span class="c1"># Old import machinary below.</span>
<span class="c1">#</span>
<span class="c1"># This is deprecated but should be kept until Airflow 2.0</span>
<span class="c1"># for compatibility.</span>
<span class="c1">#</span>
<span class="c1"># ------------------------------------------------------------------------</span>
<span class="c1"># Imports the hooks dynamically while keeping the package API clean,</span>
<span class="c1"># abstracting the underlying modules</span>
<div class="viewcode-block" id="_hooks"><a class="viewcode-back" href="../../_api/airflow/hooks/index.html#airflow.hooks._hooks">[docs]</a><span class="n">_hooks</span> <span class="o">=</span> <span class="p">{</span>
<span class="s1">&#39;base_hook&#39;</span><span class="p">:</span> <span class="p">[</span><span class="s1">&#39;BaseHook&#39;</span><span class="p">],</span>
<span class="s1">&#39;hive_hooks&#39;</span><span class="p">:</span> <span class="p">[</span>
<span class="s1">&#39;HiveCliHook&#39;</span><span class="p">,</span>
<span class="s1">&#39;HiveMetastoreHook&#39;</span><span class="p">,</span>
<span class="s1">&#39;HiveServer2Hook&#39;</span><span class="p">,</span>
<span class="p">],</span>
<span class="s1">&#39;hdfs_hook&#39;</span><span class="p">:</span> <span class="p">[</span><span class="s1">&#39;HDFSHook&#39;</span><span class="p">],</span>
<span class="s1">&#39;webhdfs_hook&#39;</span><span class="p">:</span> <span class="p">[</span><span class="s1">&#39;WebHDFSHook&#39;</span><span class="p">],</span>
<span class="s1">&#39;pig_hook&#39;</span><span class="p">:</span> <span class="p">[</span><span class="s1">&#39;PigCliHook&#39;</span><span class="p">],</span>
<span class="s1">&#39;mysql_hook&#39;</span><span class="p">:</span> <span class="p">[</span><span class="s1">&#39;MySqlHook&#39;</span><span class="p">],</span>
<span class="s1">&#39;postgres_hook&#39;</span><span class="p">:</span> <span class="p">[</span><span class="s1">&#39;PostgresHook&#39;</span><span class="p">],</span>
<span class="s1">&#39;presto_hook&#39;</span><span class="p">:</span> <span class="p">[</span><span class="s1">&#39;PrestoHook&#39;</span><span class="p">],</span>
<span class="s1">&#39;samba_hook&#39;</span><span class="p">:</span> <span class="p">[</span><span class="s1">&#39;SambaHook&#39;</span><span class="p">],</span>
<span class="s1">&#39;sqlite_hook&#39;</span><span class="p">:</span> <span class="p">[</span><span class="s1">&#39;SqliteHook&#39;</span><span class="p">],</span>
<span class="s1">&#39;S3_hook&#39;</span><span class="p">:</span> <span class="p">[</span><span class="s1">&#39;S3Hook&#39;</span><span class="p">],</span>
<span class="s1">&#39;zendesk_hook&#39;</span><span class="p">:</span> <span class="p">[</span><span class="s1">&#39;ZendeskHook&#39;</span><span class="p">],</span>
<span class="s1">&#39;http_hook&#39;</span><span class="p">:</span> <span class="p">[</span><span class="s1">&#39;HttpHook&#39;</span><span class="p">],</span>
<span class="s1">&#39;druid_hook&#39;</span><span class="p">:</span> <span class="p">[</span>
<span class="s1">&#39;DruidHook&#39;</span><span class="p">,</span>
<span class="s1">&#39;DruidDbApiHook&#39;</span><span class="p">,</span>
<span class="p">],</span>
<span class="s1">&#39;jdbc_hook&#39;</span><span class="p">:</span> <span class="p">[</span><span class="s1">&#39;JdbcHook&#39;</span><span class="p">],</span>
<span class="s1">&#39;dbapi_hook&#39;</span><span class="p">:</span> <span class="p">[</span><span class="s1">&#39;DbApiHook&#39;</span><span class="p">],</span>
<span class="s1">&#39;mssql_hook&#39;</span><span class="p">:</span> <span class="p">[</span><span class="s1">&#39;MsSqlHook&#39;</span><span class="p">],</span>
<span class="s1">&#39;oracle_hook&#39;</span><span class="p">:</span> <span class="p">[</span><span class="s1">&#39;OracleHook&#39;</span><span class="p">],</span>
<span class="s1">&#39;slack_hook&#39;</span><span class="p">:</span> <span class="p">[</span><span class="s1">&#39;SlackHook&#39;</span><span class="p">],</span></div>
<span class="p">}</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">_os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;AIRFLOW_USE_NEW_IMPORTS&#39;</span><span class="p">,</span> <span class="kc">False</span><span class="p">):</span>
<span class="kn">from</span> <span class="nn">airflow.utils.helpers</span> <span class="k">import</span> <span class="n">AirflowImporter</span>
<div class="viewcode-block" id="airflow_importer"><a class="viewcode-back" href="../../_api/airflow/hooks/index.html#airflow.hooks.airflow_importer">[docs]</a> <span class="n">airflow_importer</span> <span class="o">=</span> <span class="n">AirflowImporter</span><span class="p">(</span><span class="n">sys</span><span class="o">.</span><span class="n">modules</span><span class="p">[</span><span class="vm">__name__</span><span class="p">],</span> <span class="n">_hooks</span><span class="p">)</span></div>
<div class="viewcode-block" id="_integrate_plugins"><a class="viewcode-back" href="../../_api/airflow/hooks/index.html#airflow.hooks._integrate_plugins">[docs]</a><span class="k">def</span> <span class="nf">_integrate_plugins</span><span class="p">():</span>
<span class="sd">&quot;&quot;&quot;Integrate plugins to the context&quot;&quot;&quot;</span>
<span class="kn">from</span> <span class="nn">airflow.plugins_manager</span> <span class="k">import</span> <span class="n">hooks_modules</span>
<span class="k">for</span> <span class="n">hooks_module</span> <span class="ow">in</span> <span class="n">hooks_modules</span><span class="p">:</span>
<span class="n">sys</span><span class="o">.</span><span class="n">modules</span><span class="p">[</span><span class="n">hooks_module</span><span class="o">.</span><span class="vm">__name__</span><span class="p">]</span> <span class="o">=</span> <span class="n">hooks_module</span>
<span class="nb">globals</span><span class="p">()[</span><span class="n">hooks_module</span><span class="o">.</span><span class="n">_name</span><span class="p">]</span> <span class="o">=</span> <span class="n">hooks_module</span>
<span class="c1">##########################################################</span>
<span class="c1"># TODO FIXME Remove in Airflow 2.0</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">_os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;AIRFLOW_USE_NEW_IMPORTS&#39;</span><span class="p">,</span> <span class="kc">False</span><span class="p">):</span>
<span class="kn">from</span> <span class="nn">zope.deprecation</span> <span class="k">import</span> <span class="n">deprecated</span> <span class="k">as</span> <span class="n">_deprecated</span>
<span class="k">for</span> <span class="n">_hook</span> <span class="ow">in</span> <span class="n">hooks_module</span><span class="o">.</span><span class="n">_objects</span><span class="p">:</span>
<span class="n">hook_name</span> <span class="o">=</span> <span class="n">_hook</span><span class="o">.</span><span class="vm">__name__</span>
<span class="nb">globals</span><span class="p">()[</span><span class="n">hook_name</span><span class="p">]</span> <span class="o">=</span> <span class="n">_hook</span>
<span class="n">_deprecated</span><span class="p">(</span>
<span class="n">hook_name</span><span class="p">,</span>
<span class="s2">&quot;Importing plugin hook &#39;</span><span class="si">{i}</span><span class="s2">&#39; directly from &quot;</span>
<span class="s2">&quot;&#39;airflow.hooks&#39; has been deprecated. Please &quot;</span>
<span class="s2">&quot;import from &#39;airflow.hooks.[plugin_module]&#39; &quot;</span>
<span class="s2">&quot;instead. Support for direct imports will be dropped &quot;</span>
<span class="s2">&quot;entirely in Airflow 2.0.&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">i</span><span class="o">=</span><span class="n">hook_name</span><span class="p">))</span></div>
</pre></div>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
<div class="footer">This page uses <a href="https://analytics.google.com/">
Google Analytics</a> to collect statistics. You can disable it by blocking
the JavaScript coming from www.google-analytics.com. Check our
<a href="../../privacy_notice.html">Privacy Policy</a>
for more details.
<script type="text/javascript">
(function() {
var ga = document.createElement('script');
ga.src = ('https:' == document.location.protocol ?
'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
ga.setAttribute('async', 'true');
var nodes = document.documentElement.childNodes;
var i = -1;
var node;
do {
i++;
node = nodes[i]
} while(node.nodeType !== Node.ELEMENT_NODE);
node.appendChild(ga);
})();
</script>
</div>
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>