blob: ac313fdd25ebd625f8cf7d8e02a786794394f01b [file] [log] [blame]
<!--
Javascript to render AIRFLOW-XXX and PR references in text
as HTML links.
Overrides extrahead block from sphinx_rtd_theme
https://www.sphinx-doc.org/en/master/templating.html
-->
<!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>
<link rel="shortcut icon" href="../../../_static/pin_32.png"/>
<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/jira-links.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="stylesheet" href="../../../_static/graphviz.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/exampleinclude.css" type="text/css" />
<link rel="index" title="Index" href="../../../genindex.html" />
<link rel="search" title="Search" href="../../../search.html" />
<link rel="next" title="airflow.hooks.S3_hook" href="S3_hook/index.html" />
<link rel="prev" title="airflow.contrib.sensors.weekday_sensor" href="../contrib/sensors/weekday_sensor/index.html" />
<script>
</script>
<style>
</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.8
</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="../../../executor/index.html">Executor</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="../../../errors.html">Error Tracking</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="../../../dag-serialization.html">DAG Serialization</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="../../../best-practices.html">Best Practices</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="../../../privacy_notice.html">Privacy Notice</a></li>
</ul>
<p class="caption"><span class="caption-text">References</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="../../index.html">Python API</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../../index.html#operators">Operators</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="../../index.html#hooks">Hooks</a><ul class="current">
<li class="toctree-l3 current"><a class="reference internal" href="../../index.html#hooks-packages">Hooks packages</a><ul class="current">
<li class="toctree-l4 current"><a class="current reference internal" href="#"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.hooks</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="../contrib/hooks/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.contrib.hooks</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../index.html#executors">Executors</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../index.html#models">Models</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../index.html#core-and-community-package">Core and community package</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../../configurations-ref.html">Configurations</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">Python API Reference</a> &raquo;</li>
<li><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.hooks</span></code></li>
<li class="wy-breadcrumbs-aside">
<a href="../../../_sources/_api/airflow/hooks/index.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="module-airflow.hooks">
<span id="airflow-hooks"></span><h1><a class="reference internal" href="#module-airflow.hooks" title="airflow.hooks"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.hooks</span></code></a><a class="headerlink" href="#module-airflow.hooks" title="Permalink to this headline"></a></h1>
<div class="section" id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline"></a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="S3_hook/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.hooks.S3_hook</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="base_hook/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.hooks.base_hook</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="dbapi_hook/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.hooks.dbapi_hook</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="docker_hook/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.hooks.docker_hook</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="druid_hook/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.hooks.druid_hook</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="hdfs_hook/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.hooks.hdfs_hook</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="hive_hooks/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.hooks.hive_hooks</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="http_hook/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.hooks.http_hook</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="jdbc_hook/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.hooks.jdbc_hook</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="mssql_hook/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.hooks.mssql_hook</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="mysql_hook/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.hooks.mysql_hook</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="oracle_hook/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.hooks.oracle_hook</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="pig_hook/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.hooks.pig_hook</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="postgres_hook/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.hooks.postgres_hook</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="presto_hook/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.hooks.presto_hook</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="samba_hook/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.hooks.samba_hook</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="slack_hook/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.hooks.slack_hook</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="sqlite_hook/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.hooks.sqlite_hook</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="webhdfs_hook/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.hooks.webhdfs_hook</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="zendesk_hook/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.hooks.zendesk_hook</span></code></a></li>
</ul>
</div>
</div>
<div class="section" id="package-contents">
<h2>Package Contents<a class="headerlink" href="#package-contents" title="Permalink to this headline"></a></h2>
<dl class="data">
<dt id="airflow.hooks._hooks">
<code class="sig-prename descclassname">airflow.hooks.</code><code class="sig-name descname">_hooks</code><a class="reference internal" href="../../../_modules/airflow/hooks.html#_hooks"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.hooks._hooks" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="airflow.hooks.airflow_importer">
<code class="sig-prename descclassname">airflow.hooks.</code><code class="sig-name descname">airflow_importer</code><a class="reference internal" href="../../../_modules/airflow/hooks.html#airflow_importer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.hooks.airflow_importer" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="airflow.hooks._integrate_plugins">
<code class="sig-prename descclassname">airflow.hooks.</code><code class="sig-name descname">_integrate_plugins</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/airflow/hooks.html#_integrate_plugins"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.hooks._integrate_plugins" title="Permalink to this definition"></a></dt>
<dt>
<code class="sig-name descname">Integrate plugins to the context</code></dt>
<dd></dd></dl>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="S3_hook/index.html" class="btn btn-neutral float-right" title="airflow.hooks.S3_hook" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="../contrib/sensors/weekday_sensor/index.html" class="btn btn-neutral float-left" title="airflow.contrib.sensors.weekday_sensor" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<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.
</div>
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
<!-- Theme Analytics -->
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-140539454-1', 'auto');
ga('send', 'pageview');
</script>
</body>
</html>