docs-archive/1.10.8/_modules/airflow/hooks/jdbc_hook.html - airflow-site - Git at Google



 <!--
 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.jdbc_hook &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" />

   <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>
 <li class="toctree-l1"><a class="reference internal" href="../../../_api/index.html">Python API</a></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">Module code</a> &raquo;</li>

           <li><a href="../hooks.html">airflow.hooks</a> &raquo;</li>

       <li>airflow.hooks.jdbc_hook</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.jdbc_hook</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">from</span> <span class="nn">builtins</span> <span class="kn">import</span> <span class="nb">str</span>

 <span class="kn">import</span> <span class="nn">jaydebeapi</span>

 <span class="kn">from</span> <span class="nn">airflow.hooks.dbapi_hook</span> <span class="kn">import</span> <span class="n">DbApiHook</span>


 <div class="viewcode-block" id="JdbcHook"><a class="viewcode-back" href="../../../_api/airflow/hooks/jdbc_hook/index.html#airflow.hooks.jdbc_hook.JdbcHook">[docs]</a><span class="k">class</span> <span class="nc">JdbcHook</span><span class="p">(</span><span class="n">DbApiHook</span><span class="p">):</span>
     <span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    General hook for jdbc db access.</span>

 <span class="sd">    JDBC URL, username and password will be taken from the predefined connection.</span>
 <span class="sd">    Note that the whole JDBC URL must be specified in the &quot;host&quot; field in the DB.</span>
 <span class="sd">    Raises an airflow error if the given connection id doesn&#39;t exist.</span>
 <span class="sd">    &quot;&quot;&quot;</span>

 <div class="viewcode-block" id="JdbcHook.conn_name_attr"><a class="viewcode-back" href="../../../_api/airflow/hooks/jdbc_hook/index.html#airflow.hooks.jdbc_hook.JdbcHook.conn_name_attr">[docs]</a>    <span class="n">conn_name_attr</span> <span class="o">=</span> <span class="s1">&#39;jdbc_conn_id&#39;</span></div>
 <div class="viewcode-block" id="JdbcHook.default_conn_name"><a class="viewcode-back" href="../../../_api/airflow/hooks/jdbc_hook/index.html#airflow.hooks.jdbc_hook.JdbcHook.default_conn_name">[docs]</a>    <span class="n">default_conn_name</span> <span class="o">=</span> <span class="s1">&#39;jdbc_default&#39;</span></div>
 <div class="viewcode-block" id="JdbcHook.supports_autocommit"><a class="viewcode-back" href="../../../_api/airflow/hooks/jdbc_hook/index.html#airflow.hooks.jdbc_hook.JdbcHook.supports_autocommit">[docs]</a>    <span class="n">supports_autocommit</span> <span class="o">=</span> <span class="kc">True</span></div>

 <div class="viewcode-block" id="JdbcHook.get_conn"><a class="viewcode-back" href="../../../_api/airflow/hooks/jdbc_hook/index.html#airflow.hooks.jdbc_hook.JdbcHook.get_conn">[docs]</a>    <span class="k">def</span> <span class="nf">get_conn</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
         <span class="n">conn</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_connection</span><span class="p">(</span><span class="nb">getattr</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">conn_name_attr</span><span class="p">))</span>
         <span class="n">host</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">host</span>
         <span class="n">login</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">login</span>
         <span class="n">psw</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">password</span>
         <span class="n">jdbc_driver_loc</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">extra_dejson</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;extra__jdbc__drv_path&#39;</span><span class="p">)</span>
         <span class="n">jdbc_driver_name</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">extra_dejson</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;extra__jdbc__drv_clsname&#39;</span><span class="p">)</span>

         <span class="n">conn</span> <span class="o">=</span> <span class="n">jaydebeapi</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="n">jclassname</span><span class="o">=</span><span class="n">jdbc_driver_name</span><span class="p">,</span>
                                   <span class="n">url</span><span class="o">=</span><span class="nb">str</span><span class="p">(</span><span class="n">host</span><span class="p">),</span>
                                   <span class="n">driver_args</span><span class="o">=</span><span class="p">[</span><span class="nb">str</span><span class="p">(</span><span class="n">login</span><span class="p">),</span> <span class="nb">str</span><span class="p">(</span><span class="n">psw</span><span class="p">)],</span>
                                   <span class="n">jars</span><span class="o">=</span><span class="n">jdbc_driver_loc</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">&quot;,&quot;</span><span class="p">))</span>
         <span class="k">return</span> <span class="n">conn</span></div>

 <div class="viewcode-block" id="JdbcHook.set_autocommit"><a class="viewcode-back" href="../../../_api/airflow/hooks/jdbc_hook/index.html#airflow.hooks.jdbc_hook.JdbcHook.set_autocommit">[docs]</a>    <span class="k">def</span> <span class="nf">set_autocommit</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">conn</span><span class="p">,</span> <span class="n">autocommit</span><span class="p">):</span>
         <span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        Enable or disable autocommit for the given connection.</span>

 <span class="sd">        :param conn: The connection.</span>
 <span class="sd">        :type conn: connection object</span>
 <span class="sd">        :param autocommit: The connection&#39;s autocommit setting.</span>
 <span class="sd">        :type autocommit: bool</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="n">conn</span><span class="o">.</span><span class="n">jconn</span><span class="o">.</span><span class="n">setAutoCommit</span><span class="p">(</span><span class="n">autocommit</span><span class="p">)</span></div>

 <div class="viewcode-block" id="JdbcHook.get_autocommit"><a class="viewcode-back" href="../../../_api/airflow/hooks/jdbc_hook/index.html#airflow.hooks.jdbc_hook.JdbcHook.get_autocommit">[docs]</a>    <span class="k">def</span> <span class="nf">get_autocommit</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">conn</span><span class="p">):</span>
         <span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        Get autocommit setting for the provided connection.</span>
 <span class="sd">        Return True if conn.autocommit is set to True.</span>
 <span class="sd">        Return False if conn.autocommit is not set or set to False</span>

 <span class="sd">        :param conn: The connection.</span>
 <span class="sd">        :type conn: connection object</span>
 <span class="sd">        :return: connection autocommit setting.</span>
 <span class="sd">        :rtype: bool</span>
 <span class="sd">        &quot;&quot;&quot;</span>

         <span class="k">return</span> <span class="n">conn</span><span class="o">.</span><span class="n">jconn</span><span class="o">.</span><span class="n">getAutoCommit</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>.
   <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>


	<!--
	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.jdbc_hook — 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" />

	<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 & 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>
	<li class="toctree-l1"><a class="reference internal" href="../../../_api/index.html">Python API</a></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> »</li>

	<li><a href="../../index.html">Module code</a> »</li>

	<li><a href="../hooks.html">airflow.hooks</a> »</li>

	<li>airflow.hooks.jdbc_hook</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.jdbc_hook</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">builtins</span> <span class="kn">import</span> <span class="nb">str</span>

	<span class="kn">import</span> <span class="nn">jaydebeapi</span>

	<span class="kn">from</span> <span class="nn">airflow.hooks.dbapi_hook</span> <span class="kn">import</span> <span class="n">DbApiHook</span>


	<div class="viewcode-block" id="JdbcHook"><a class="viewcode-back" href="../../../_api/airflow/hooks/jdbc_hook/index.html#airflow.hooks.jdbc_hook.JdbcHook">[docs]</a><span class="k">class</span> <span class="nc">JdbcHook</span><span class="p">(</span><span class="n">DbApiHook</span><span class="p">):</span>
	<span class="sd">"""</span>
	<span class="sd"> General hook for jdbc db access.</span>

	<span class="sd"> JDBC URL, username and password will be taken from the predefined connection.</span>
	<span class="sd"> Note that the whole JDBC URL must be specified in the "host" field in the DB.</span>
	<span class="sd"> Raises an airflow error if the given connection id doesn't exist.</span>
	<span class="sd"> """</span>

	<div class="viewcode-block" id="JdbcHook.conn_name_attr"><a class="viewcode-back" href="../../../_api/airflow/hooks/jdbc_hook/index.html#airflow.hooks.jdbc_hook.JdbcHook.conn_name_attr">[docs]</a> <span class="n">conn_name_attr</span> <span class="o">=</span> <span class="s1">'jdbc_conn_id'</span></div>
	<div class="viewcode-block" id="JdbcHook.default_conn_name"><a class="viewcode-back" href="../../../_api/airflow/hooks/jdbc_hook/index.html#airflow.hooks.jdbc_hook.JdbcHook.default_conn_name">[docs]</a> <span class="n">default_conn_name</span> <span class="o">=</span> <span class="s1">'jdbc_default'</span></div>
	<div class="viewcode-block" id="JdbcHook.supports_autocommit"><a class="viewcode-back" href="../../../_api/airflow/hooks/jdbc_hook/index.html#airflow.hooks.jdbc_hook.JdbcHook.supports_autocommit">[docs]</a> <span class="n">supports_autocommit</span> <span class="o">=</span> <span class="kc">True</span></div>

	<div class="viewcode-block" id="JdbcHook.get_conn"><a class="viewcode-back" href="../../../_api/airflow/hooks/jdbc_hook/index.html#airflow.hooks.jdbc_hook.JdbcHook.get_conn">[docs]</a> <span class="k">def</span> <span class="nf">get_conn</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
	<span class="n">conn</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_connection</span><span class="p">(</span><span class="nb">getattr</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">conn_name_attr</span><span class="p">))</span>
	<span class="n">host</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">host</span>
	<span class="n">login</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">login</span>
	<span class="n">psw</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">password</span>
	<span class="n">jdbc_driver_loc</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">extra_dejson</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'extra__jdbc__drv_path'</span><span class="p">)</span>
	<span class="n">jdbc_driver_name</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">extra_dejson</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'extra__jdbc__drv_clsname'</span><span class="p">)</span>

	<span class="n">conn</span> <span class="o">=</span> <span class="n">jaydebeapi</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="n">jclassname</span><span class="o">=</span><span class="n">jdbc_driver_name</span><span class="p">,</span>
	<span class="n">url</span><span class="o">=</span><span class="nb">str</span><span class="p">(</span><span class="n">host</span><span class="p">),</span>
	<span class="n">driver_args</span><span class="o">=</span><span class="p">[</span><span class="nb">str</span><span class="p">(</span><span class="n">login</span><span class="p">),</span> <span class="nb">str</span><span class="p">(</span><span class="n">psw</span><span class="p">)],</span>
	<span class="n">jars</span><span class="o">=</span><span class="n">jdbc_driver_loc</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">","</span><span class="p">))</span>
	<span class="k">return</span> <span class="n">conn</span></div>

	<div class="viewcode-block" id="JdbcHook.set_autocommit"><a class="viewcode-back" href="../../../_api/airflow/hooks/jdbc_hook/index.html#airflow.hooks.jdbc_hook.JdbcHook.set_autocommit">[docs]</a> <span class="k">def</span> <span class="nf">set_autocommit</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">conn</span><span class="p">,</span> <span class="n">autocommit</span><span class="p">):</span>
	<span class="sd">"""</span>
	<span class="sd"> Enable or disable autocommit for the given connection.</span>

	<span class="sd"> :param conn: The connection.</span>
	<span class="sd"> :type conn: connection object</span>
	<span class="sd"> :param autocommit: The connection's autocommit setting.</span>
	<span class="sd"> :type autocommit: bool</span>
	<span class="sd"> """</span>
	<span class="n">conn</span><span class="o">.</span><span class="n">jconn</span><span class="o">.</span><span class="n">setAutoCommit</span><span class="p">(</span><span class="n">autocommit</span><span class="p">)</span></div>

	<div class="viewcode-block" id="JdbcHook.get_autocommit"><a class="viewcode-back" href="../../../_api/airflow/hooks/jdbc_hook/index.html#airflow.hooks.jdbc_hook.JdbcHook.get_autocommit">[docs]</a> <span class="k">def</span> <span class="nf">get_autocommit</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">conn</span><span class="p">):</span>
	<span class="sd">"""</span>
	<span class="sd"> Get autocommit setting for the provided connection.</span>
	<span class="sd"> Return True if conn.autocommit is set to True.</span>
	<span class="sd"> Return False if conn.autocommit is not set or set to False</span>

	<span class="sd"> :param conn: The connection.</span>
	<span class="sd"> :type conn: connection object</span>
	<span class="sd"> :return: connection autocommit setting.</span>
	<span class="sd"> :rtype: bool</span>
	<span class="sd"> """</span>

	<span class="k">return</span> <span class="n">conn</span><span class="o">.</span><span class="n">jconn</span><span class="o">.</span><span class="n">getAutoCommit</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>.
	<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>