docs-archive/1.10.4/_modules/airflow/contrib/hooks/cloudant_hook.html - airflow-site - Git at Google



 <!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.hooks.cloudant_hook &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="../hooks.html">airflow.contrib.hooks</a> &raquo;</li>

       <li>airflow.contrib.hooks.cloudant_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.contrib.hooks.cloudant_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">past.builtins</span> <span class="k">import</span> <span class="n">unicode</span>

 <span class="kn">import</span> <span class="nn">cloudant</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.hooks.base_hook</span> <span class="k">import</span> <span class="n">BaseHook</span>
 <span class="kn">from</span> <span class="nn">airflow.utils.log.logging_mixin</span> <span class="k">import</span> <span class="n">LoggingMixin</span>


 <div class="viewcode-block" id="CloudantHook"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/cloudant_hook/index.html#airflow.contrib.hooks.cloudant_hook.CloudantHook">[docs]</a><span class="k">class</span> <span class="nc">CloudantHook</span><span class="p">(</span><span class="n">BaseHook</span><span class="p">):</span>
     <span class="sd">&quot;&quot;&quot;Interact with Cloudant.</span>

 <span class="sd">    This class is a thin wrapper around the cloudant python library. See the</span>
 <span class="sd">    documentation `here &lt;https://github.com/cloudant-labs/cloudant-python&gt;`_.</span>
 <span class="sd">    &quot;&quot;&quot;</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">cloudant_conn_id</span><span class="o">=</span><span class="s1">&#39;cloudant_default&#39;</span><span class="p">):</span>
         <span class="nb">super</span><span class="p">(</span><span class="n">CloudantHook</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="s1">&#39;cloudant&#39;</span><span class="p">)</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">cloudant_conn_id</span> <span class="o">=</span> <span class="n">cloudant_conn_id</span>

 <div class="viewcode-block" id="CloudantHook.get_conn"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/cloudant_hook/index.html#airflow.contrib.hooks.cloudant_hook.CloudantHook.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="k">def</span> <span class="nf">_str</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
             <span class="c1"># cloudant-python doesn&#39;t support unicode.</span>
             <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">unicode</span><span class="p">):</span>
                 <span class="n">log</span> <span class="o">=</span> <span class="n">LoggingMixin</span><span class="p">()</span><span class="o">.</span><span class="n">log</span>
                 <span class="n">log</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span>
                     <span class="s1">&#39;cloudant-python does not support unicode. Encoding </span><span class="si">%s</span><span class="s1"> as &#39;</span>
                     <span class="s1">&#39;ascii using &quot;ignore&quot;.&#39;</span><span class="p">,</span> <span class="n">s</span>
                 <span class="p">)</span>
                 <span class="k">return</span> <span class="n">s</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s1">&#39;ascii&#39;</span><span class="p">,</span> <span class="s1">&#39;ignore&#39;</span><span class="p">)</span>

             <span class="k">return</span> <span class="n">s</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="bp">self</span><span class="o">.</span><span class="n">cloudant_conn_id</span><span class="p">)</span>

         <span class="k">for</span> <span class="n">conn_param</span> <span class="ow">in</span> <span class="p">[</span><span class="s1">&#39;host&#39;</span><span class="p">,</span> <span class="s1">&#39;password&#39;</span><span class="p">,</span> <span class="s1">&#39;schema&#39;</span><span class="p">]:</span>
             <span class="k">if</span> <span class="ow">not</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">conn</span><span class="p">,</span> <span class="n">conn_param</span><span class="p">)</span> <span class="ow">or</span> <span class="ow">not</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">conn</span><span class="p">,</span> <span class="n">conn_param</span><span class="p">):</span>
                 <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span>
                     <span class="s1">&#39;missing connection parameter </span><span class="si">{0}</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">conn_param</span><span class="p">)</span>
                 <span class="p">)</span>

         <span class="c1"># In the connection form:</span>
         <span class="c1"># - &#39;host&#39; is renamed to &#39;Account&#39;</span>
         <span class="c1"># - &#39;login&#39; is renamed &#39;Username (or API Key)&#39;</span>
         <span class="c1"># - &#39;schema&#39; is renamed to &#39;Database&#39;</span>
         <span class="c1">#</span>
         <span class="c1"># So, use the &#39;host&#39; attribute as the account name, and, if login is</span>
         <span class="c1"># defined, use that as the username.</span>
         <span class="n">account</span> <span class="o">=</span> <span class="n">cloudant</span><span class="o">.</span><span class="n">Account</span><span class="p">(</span><span class="n">_str</span><span class="p">(</span><span class="n">conn</span><span class="o">.</span><span class="n">host</span><span class="p">))</span>

         <span class="n">username</span> <span class="o">=</span> <span class="n">_str</span><span class="p">(</span><span class="n">conn</span><span class="o">.</span><span class="n">login</span> <span class="ow">or</span> <span class="n">conn</span><span class="o">.</span><span class="n">host</span><span class="p">)</span>

         <span class="n">account</span><span class="o">.</span><span class="n">login</span><span class="p">(</span>
             <span class="n">username</span><span class="p">,</span>
             <span class="n">_str</span><span class="p">(</span><span class="n">conn</span><span class="o">.</span><span class="n">password</span><span class="p">))</span><span class="o">.</span><span class="n">raise_for_status</span><span class="p">()</span>

         <span class="k">return</span> <span class="n">account</span><span class="o">.</span><span class="n">database</span><span class="p">(</span><span class="n">_str</span><span class="p">(</span><span class="n">conn</span><span class="o">.</span><span class="n">schema</span><span class="p">))</span></div>

 <div class="viewcode-block" id="CloudantHook.db"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/cloudant_hook/index.html#airflow.contrib.hooks.cloudant_hook.CloudantHook.db">[docs]</a>    <span class="k">def</span> <span class="nf">db</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
         <span class="sd">&quot;&quot;&quot;Returns the Database object for this hook.</span>

 <span class="sd">        See the documentation for cloudant-python here</span>
 <span class="sd">        https://github.com/cloudant-labs/cloudant-python.</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_conn</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>




	<!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.hooks.cloudant_hook — 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 & 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> »</li>

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

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

	<li>airflow.contrib.hooks.cloudant_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.contrib.hooks.cloudant_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">past.builtins</span> <span class="k">import</span> <span class="n">unicode</span>

	<span class="kn">import</span> <span class="nn">cloudant</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.hooks.base_hook</span> <span class="k">import</span> <span class="n">BaseHook</span>
	<span class="kn">from</span> <span class="nn">airflow.utils.log.logging_mixin</span> <span class="k">import</span> <span class="n">LoggingMixin</span>


	<div class="viewcode-block" id="CloudantHook"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/cloudant_hook/index.html#airflow.contrib.hooks.cloudant_hook.CloudantHook">[docs]</a><span class="k">class</span> <span class="nc">CloudantHook</span><span class="p">(</span><span class="n">BaseHook</span><span class="p">):</span>
	<span class="sd">"""Interact with Cloudant.</span>

	<span class="sd"> This class is a thin wrapper around the cloudant python library. See the</span>
	<span class="sd"> documentation `here <https://github.com/cloudant-labs/cloudant-python>`_.</span>
	<span class="sd"> """</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">cloudant_conn_id</span><span class="o">=</span><span class="s1">'cloudant_default'</span><span class="p">):</span>
	<span class="nb">super</span><span class="p">(</span><span class="n">CloudantHook</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="s1">'cloudant'</span><span class="p">)</span>
	<span class="bp">self</span><span class="o">.</span><span class="n">cloudant_conn_id</span> <span class="o">=</span> <span class="n">cloudant_conn_id</span>

	<div class="viewcode-block" id="CloudantHook.get_conn"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/cloudant_hook/index.html#airflow.contrib.hooks.cloudant_hook.CloudantHook.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="k">def</span> <span class="nf">_str</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
	<span class="c1"># cloudant-python doesn't support unicode.</span>
	<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">unicode</span><span class="p">):</span>
	<span class="n">log</span> <span class="o">=</span> <span class="n">LoggingMixin</span><span class="p">()</span><span class="o">.</span><span class="n">log</span>
	<span class="n">log</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span>
	<span class="s1">'cloudant-python does not support unicode. Encoding </span><span class="si">%s</span><span class="s1"> as '</span>
	<span class="s1">'ascii using "ignore".'</span><span class="p">,</span> <span class="n">s</span>
	<span class="p">)</span>
	<span class="k">return</span> <span class="n">s</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s1">'ascii'</span><span class="p">,</span> <span class="s1">'ignore'</span><span class="p">)</span>

	<span class="k">return</span> <span class="n">s</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="bp">self</span><span class="o">.</span><span class="n">cloudant_conn_id</span><span class="p">)</span>

	<span class="k">for</span> <span class="n">conn_param</span> <span class="ow">in</span> <span class="p">[</span><span class="s1">'host'</span><span class="p">,</span> <span class="s1">'password'</span><span class="p">,</span> <span class="s1">'schema'</span><span class="p">]:</span>
	<span class="k">if</span> <span class="ow">not</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">conn</span><span class="p">,</span> <span class="n">conn_param</span><span class="p">)</span> <span class="ow">or</span> <span class="ow">not</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">conn</span><span class="p">,</span> <span class="n">conn_param</span><span class="p">):</span>
	<span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span>
	<span class="s1">'missing connection parameter </span><span class="si">{0}</span><span class="s1">'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">conn_param</span><span class="p">)</span>
	<span class="p">)</span>

	<span class="c1"># In the connection form:</span>
	<span class="c1"># - 'host' is renamed to 'Account'</span>
	<span class="c1"># - 'login' is renamed 'Username (or API Key)'</span>
	<span class="c1"># - 'schema' is renamed to 'Database'</span>
	<span class="c1">#</span>
	<span class="c1"># So, use the 'host' attribute as the account name, and, if login is</span>
	<span class="c1"># defined, use that as the username.</span>
	<span class="n">account</span> <span class="o">=</span> <span class="n">cloudant</span><span class="o">.</span><span class="n">Account</span><span class="p">(</span><span class="n">_str</span><span class="p">(</span><span class="n">conn</span><span class="o">.</span><span class="n">host</span><span class="p">))</span>

	<span class="n">username</span> <span class="o">=</span> <span class="n">_str</span><span class="p">(</span><span class="n">conn</span><span class="o">.</span><span class="n">login</span> <span class="ow">or</span> <span class="n">conn</span><span class="o">.</span><span class="n">host</span><span class="p">)</span>

	<span class="n">account</span><span class="o">.</span><span class="n">login</span><span class="p">(</span>
	<span class="n">username</span><span class="p">,</span>
	<span class="n">_str</span><span class="p">(</span><span class="n">conn</span><span class="o">.</span><span class="n">password</span><span class="p">))</span><span class="o">.</span><span class="n">raise_for_status</span><span class="p">()</span>

	<span class="k">return</span> <span class="n">account</span><span class="o">.</span><span class="n">database</span><span class="p">(</span><span class="n">_str</span><span class="p">(</span><span class="n">conn</span><span class="o">.</span><span class="n">schema</span><span class="p">))</span></div>

	<div class="viewcode-block" id="CloudantHook.db"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/cloudant_hook/index.html#airflow.contrib.hooks.cloudant_hook.CloudantHook.db">[docs]</a> <span class="k">def</span> <span class="nf">db</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
	<span class="sd">"""Returns the Database object for this hook.</span>

	<span class="sd"> See the documentation for cloudant-python here</span>
	<span class="sd"> https://github.com/cloudant-labs/cloudant-python.</span>
	<span class="sd"> """</span>
	<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_conn</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>