You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by ka...@apache.org on 2018/08/29 20:24:57 UTC
[29/48] incubator-airflow-site git commit: 1.10.0 with Updated Api
Reference
http://git-wip-us.apache.org/repos/asf/incubator-airflow-site/blob/7d4d7628/_modules/airflow/hooks/http_hook.html
----------------------------------------------------------------------
diff --git a/_modules/airflow/hooks/http_hook.html b/_modules/airflow/hooks/http_hook.html
index 0df6ddc..46340b7 100644
--- a/_modules/airflow/hooks/http_hook.html
+++ b/_modules/airflow/hooks/http_hook.html
@@ -24,26 +24,17 @@
-
-
- <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
-
-
-
-
-
- <link rel="index" title="Index"
- href="../../../genindex.html"/>
- <link rel="search" title="Search" href="../../../search.html"/>
- <link rel="top" title="Airflow Documentation" href="../../../index.html"/>
- <link rel="up" title="Module code" href="../../index.html"/>
+ <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 src="../../../_static/js/modernizr.min.js"></script>
</head>
-<body class="wy-body-for-nav" role="document">
+<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
@@ -116,7 +107,7 @@
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
- <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <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>
@@ -124,9 +115,10 @@
</nav>
-
<div class="wy-nav-content">
+
<div class="rst-content">
+
@@ -156,8 +148,6 @@
<li class="wy-breadcrumbs-aside">
-
-
</li>
</ul>
@@ -178,9 +168,9 @@
<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">#</span>
<span class="c1"># http://www.apache.org/licenses/LICENSE-2.0</span>
-<span class="c1"># </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>
@@ -191,6 +181,7 @@
<span class="kn">from</span> <span class="nn">builtins</span> <span class="k">import</span> <span class="nb">str</span>
<span class="kn">import</span> <span class="nn">requests</span>
+<span class="kn">import</span> <span class="nn">tenacity</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.exceptions</span> <span class="k">import</span> <span class="n">AirflowException</span>
@@ -199,16 +190,31 @@
<div class="viewcode-block" id="HttpHook"><a class="viewcode-back" href="../../../code.html#airflow.hooks.http_hook.HttpHook">[docs]</a><span class="k">class</span> <span class="nc">HttpHook</span><span class="p">(</span><span class="n">BaseHook</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Interact with HTTP servers.</span>
+<span class="sd"> :param http_conn_id: connection that has the base API url i.e https://www.google.com/</span>
+<span class="sd"> and optional authentication credentials. Default headers can also be specified in</span>
+<span class="sd"> the Extra field in json format.</span>
+<span class="sd"> :type http_conn_id: str</span>
+<span class="sd"> :param method: the API method to be called</span>
+<span class="sd"> :type method: str</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">method</span><span class="o">=</span><span class="s1">'POST'</span><span class="p">,</span> <span class="n">http_conn_id</span><span class="o">=</span><span class="s1">'http_default'</span><span class="p">):</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">method</span><span class="o">=</span><span class="s1">'POST'</span><span class="p">,</span>
+ <span class="n">http_conn_id</span><span class="o">=</span><span class="s1">'http_default'</span>
+ <span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">http_conn_id</span> <span class="o">=</span> <span class="n">http_conn_id</span>
<span class="bp">self</span><span class="o">.</span><span class="n">method</span> <span class="o">=</span> <span class="n">method</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">base_url</span> <span class="o">=</span> <span class="kc">None</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_retry_obj</span> <span class="o">=</span> <span class="kc">None</span>
- <span class="c1"># headers is required to make it required</span>
-<div class="viewcode-block" id="HttpHook.get_conn"><a class="viewcode-back" href="../../../code.html#airflow.hooks.http_hook.HttpHook.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">headers</span><span class="p">):</span>
+ <span class="c1"># headers may be passed through directly or in the "extra" field in the connection</span>
+ <span class="c1"># definition</span>
+<div class="viewcode-block" id="HttpHook.get_conn"><a class="viewcode-back" href="../../../code.html#airflow.hooks.http_hook.HttpHook.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">headers</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Returns http session for use with requests</span>
+<span class="sd"> :param headers: additional headers to be passed through as a dictionary</span>
+<span class="sd"> :type headers: dict</span>
<span class="sd"> """</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">http_conn_id</span><span class="p">)</span>
<span class="n">session</span> <span class="o">=</span> <span class="n">requests</span><span class="o">.</span><span class="n">Session</span><span class="p">()</span>
@@ -221,9 +227,11 @@
<span class="bp">self</span><span class="o">.</span><span class="n">base_url</span> <span class="o">=</span> <span class="n">schema</span> <span class="o">+</span> <span class="s2">"://"</span> <span class="o">+</span> <span class="n">conn</span><span class="o">.</span><span class="n">host</span>
<span class="k">if</span> <span class="n">conn</span><span class="o">.</span><span class="n">port</span><span class="p">:</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">base_url</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">base_url</span> <span class="o">+</span> <span class="s2">":"</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">conn</span><span class="o">.</span><span class="n">port</span><span class="p">)</span> <span class="o">+</span> <span class="s2">"/"</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">base_url</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">base_url</span> <span class="o">+</span> <span class="s2">":"</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">conn</span><span class="o">.</span><span class="n">port</span><span class="p">)</span>
<span class="k">if</span> <span class="n">conn</span><span class="o">.</span><span class="n">login</span><span class="p">:</span>
<span class="n">session</span><span class="o">.</span><span class="n">auth</span> <span class="o">=</span> <span class="p">(</span><span class="n">conn</span><span class="o">.</span><span class="n">login</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="k">if</span> <span class="n">conn</span><span class="o">.</span><span class="n">extra</span><span class="p">:</span>
+ <span class="n">session</span><span class="o">.</span><span class="n">headers</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">conn</span><span class="o">.</span><span class="n">extra_dejson</span><span class="p">)</span>
<span class="k">if</span> <span class="n">headers</span><span class="p">:</span>
<span class="n">session</span><span class="o">.</span><span class="n">headers</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">headers</span><span class="p">)</span>
@@ -232,6 +240,16 @@
<div class="viewcode-block" id="HttpHook.run"><a class="viewcode-back" href="../../../code.html#airflow.hooks.http_hook.HttpHook.run">[docs]</a> <span class="k">def</span> <span class="nf">run</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">endpoint</span><span class="p">,</span> <span class="n">data</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">headers</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">extra_options</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Performs the request</span>
+<span class="sd"> :param endpoint: the endpoint to be called i.e. resource/v1/query?</span>
+<span class="sd"> :type endpoint: str</span>
+<span class="sd"> :param data: payload to be uploaded or request parameters</span>
+<span class="sd"> :type data: dict</span>
+<span class="sd"> :param headers: additional headers to be passed through as a dictionary</span>
+<span class="sd"> :type headers: dict</span>
+<span class="sd"> :param extra_options: additional options to be used when executing the request</span>
+<span class="sd"> i.e. {'check_response': False} to avoid checking raising exceptions on non</span>
+<span class="sd"> 2XX or 3XX status codes</span>
+<span class="sd"> :type extra_options: dict</span>
<span class="sd"> """</span>
<span class="n">extra_options</span> <span class="o">=</span> <span class="n">extra_options</span> <span class="ow">or</span> <span class="p">{}</span>
@@ -261,43 +279,85 @@
<span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">"Sending '</span><span class="si">%s</span><span class="s2">' to url: </span><span class="si">%s</span><span class="s2">"</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">method</span><span class="p">,</span> <span class="n">url</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">run_and_check</span><span class="p">(</span><span class="n">session</span><span class="p">,</span> <span class="n">prepped_request</span><span class="p">,</span> <span class="n">extra_options</span><span class="p">)</span></div>
+<div class="viewcode-block" id="HttpHook.check_response"><a class="viewcode-back" href="../../../code.html#airflow.hooks.http_hook.HttpHook.check_response">[docs]</a> <span class="k">def</span> <span class="nf">check_response</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">response</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Checks the status code and raise an AirflowException exception on non 2XX or 3XX</span>
+<span class="sd"> status codes</span>
+<span class="sd"> :param response: A requests response object</span>
+<span class="sd"> :type response: requests.response</span>
+<span class="sd"> """</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="n">response</span><span class="o">.</span><span class="n">raise_for_status</span><span class="p">()</span>
+ <span class="k">except</span> <span class="n">requests</span><span class="o">.</span><span class="n">exceptions</span><span class="o">.</span><span class="n">HTTPError</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="s2">"HTTP error: </span><span class="si">%s</span><span class="s2">"</span><span class="p">,</span> <span class="n">response</span><span class="o">.</span><span class="n">reason</span><span class="p">)</span>
+ <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">method</span> <span class="ow">not</span> <span class="ow">in</span> <span class="p">[</span><span class="s1">'GET'</span><span class="p">,</span> <span class="s1">'HEAD'</span><span class="p">]:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">text</span><span class="p">)</span>
+ <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">status_code</span><span class="p">)</span> <span class="o">+</span> <span class="s2">":"</span> <span class="o">+</span> <span class="n">response</span><span class="o">.</span><span class="n">reason</span><span class="p">)</span></div>
+
<div class="viewcode-block" id="HttpHook.run_and_check"><a class="viewcode-back" href="../../../code.html#airflow.hooks.http_hook.HttpHook.run_and_check">[docs]</a> <span class="k">def</span> <span class="nf">run_and_check</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">session</span><span class="p">,</span> <span class="n">prepped_request</span><span class="p">,</span> <span class="n">extra_options</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Grabs extra options like timeout and actually runs the request,</span>
<span class="sd"> checking for the result</span>
+<span class="sd"> :param session: the session to be used to execute the request</span>
+<span class="sd"> :type session: requests.Session</span>
+<span class="sd"> :param prepped_request: the prepared request generated in run()</span>
+<span class="sd"> :type prepped_request: session.prepare_request</span>
+<span class="sd"> :param extra_options: additional options to be used when executing the request</span>
+<span class="sd"> i.e. {'check_response': False} to avoid checking raising exceptions on non 2XX</span>
+<span class="sd"> or 3XX status codes</span>
+<span class="sd"> :type extra_options: dict</span>
<span class="sd"> """</span>
<span class="n">extra_options</span> <span class="o">=</span> <span class="n">extra_options</span> <span class="ow">or</span> <span class="p">{}</span>
- <span class="n">response</span> <span class="o">=</span> <span class="n">session</span><span class="o">.</span><span class="n">send</span><span class="p">(</span>
- <span class="n">prepped_request</span><span class="p">,</span>
- <span class="n">stream</span><span class="o">=</span><span class="n">extra_options</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"stream"</span><span class="p">,</span> <span class="kc">False</span><span class="p">),</span>
- <span class="n">verify</span><span class="o">=</span><span class="n">extra_options</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"verify"</span><span class="p">,</span> <span class="kc">False</span><span class="p">),</span>
- <span class="n">proxies</span><span class="o">=</span><span class="n">extra_options</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"proxies"</span><span class="p">,</span> <span class="p">{}),</span>
- <span class="n">cert</span><span class="o">=</span><span class="n">extra_options</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"cert"</span><span class="p">),</span>
- <span class="n">timeout</span><span class="o">=</span><span class="n">extra_options</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"timeout"</span><span class="p">),</span>
- <span class="n">allow_redirects</span><span class="o">=</span><span class="n">extra_options</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"allow_redirects"</span><span class="p">,</span> <span class="kc">True</span><span class="p">))</span>
-
<span class="k">try</span><span class="p">:</span>
- <span class="n">response</span><span class="o">.</span><span class="n">raise_for_status</span><span class="p">()</span>
- <span class="k">except</span> <span class="n">requests</span><span class="o">.</span><span class="n">exceptions</span><span class="o">.</span><span class="n">HTTPError</span><span class="p">:</span>
- <span class="c1"># Tried rewrapping, but not supported. This way, it's possible</span>
- <span class="c1"># to get reason and code for failure by checking first 3 chars</span>
- <span class="c1"># for the code, or do a split on ':'</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="s2">"HTTP error: </span><span class="si">%s</span><span class="s2">"</span><span class="p">,</span> <span class="n">response</span><span class="o">.</span><span class="n">reason</span><span class="p">)</span>
- <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">method</span> <span class="ow">not</span> <span class="ow">in</span> <span class="p">(</span><span class="s1">'GET'</span><span class="p">,</span> <span class="s1">'HEAD'</span><span class="p">):</span>
- <span class="c1"># The sensor uses GET, so this prevents filling up the log</span>
- <span class="c1"># with the body every time the GET 'misses'.</span>
- <span class="c1"># That's ok to do, because GETs should be repeatable and</span>
- <span class="c1"># all data should be visible in the log (no post data)</span>
- <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">text</span><span class="p">)</span>
- <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">status_code</span><span class="p">)</span><span class="o">+</span><span class="s2">":"</span><span class="o">+</span><span class="n">response</span><span class="o">.</span><span class="n">reason</span><span class="p">)</span>
- <span class="k">return</span> <span class="n">response</span></div></div>
+ <span class="n">response</span> <span class="o">=</span> <span class="n">session</span><span class="o">.</span><span class="n">send</span><span class="p">(</span>
+ <span class="n">prepped_request</span><span class="p">,</span>
+ <span class="n">stream</span><span class="o">=</span><span class="n">extra_options</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"stream"</span><span class="p">,</span> <span class="kc">False</span><span class="p">),</span>
+ <span class="n">verify</span><span class="o">=</span><span class="n">extra_options</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"verify"</span><span class="p">,</span> <span class="kc">False</span><span class="p">),</span>
+ <span class="n">proxies</span><span class="o">=</span><span class="n">extra_options</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"proxies"</span><span class="p">,</span> <span class="p">{}),</span>
+ <span class="n">cert</span><span class="o">=</span><span class="n">extra_options</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"cert"</span><span class="p">),</span>
+ <span class="n">timeout</span><span class="o">=</span><span class="n">extra_options</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"timeout"</span><span class="p">),</span>
+ <span class="n">allow_redirects</span><span class="o">=</span><span class="n">extra_options</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"allow_redirects"</span><span class="p">,</span> <span class="kc">True</span><span class="p">))</span>
+
+ <span class="k">if</span> <span class="n">extra_options</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'check_response'</span><span class="p">,</span> <span class="kc">True</span><span class="p">):</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">check_response</span><span class="p">(</span><span class="n">response</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">response</span>
+
+ <span class="k">except</span> <span class="n">requests</span><span class="o">.</span><span class="n">exceptions</span><span class="o">.</span><span class="n">ConnectionError</span> <span class="k">as</span> <span class="n">ex</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">ex</span><span class="p">)</span> <span class="o">+</span> <span class="s1">' Tenacity will retry to execute the operation'</span><span class="p">)</span>
+ <span class="k">raise</span> <span class="n">ex</span></div>
+
+<div class="viewcode-block" id="HttpHook.run_with_advanced_retry"><a class="viewcode-back" href="../../../code.html#airflow.hooks.http_hook.HttpHook.run_with_advanced_retry">[docs]</a> <span class="k">def</span> <span class="nf">run_with_advanced_retry</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">_retry_args</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Runs Hook.run() with a Tenacity decorator attached to it. This is useful for</span>
+<span class="sd"> connectors which might be disturbed by intermittent issues and should not</span>
+<span class="sd"> instantly fail.</span>
+<span class="sd"> :param _retry_args: Arguments which define the retry behaviour.</span>
+<span class="sd"> See Tenacity documentation at https://github.com/jd/tenacity</span>
+<span class="sd"> :type _retry_args: dict</span>
+
+
+<span class="sd"> Example: ::</span>
+<span class="sd"> hook = HttpHook(http_conn_id='my_conn',method='GET')</span>
+<span class="sd"> retry_args = dict(</span>
+<span class="sd"> wait=tenacity.wait_exponential(),</span>
+<span class="sd"> stop=tenacity.stop_after_attempt(10),</span>
+<span class="sd"> retry=requests.exceptions.ConnectionError</span>
+<span class="sd"> )</span>
+<span class="sd"> hook.run_with_advanced_retry(</span>
+<span class="sd"> endpoint='v1/test',</span>
+<span class="sd"> _retry_args=retry_args</span>
+<span class="sd"> )</span>
+<span class="sd"> """</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_retry_obj</span> <span class="o">=</span> <span class="n">tenacity</span><span class="o">.</span><span class="n">Retrying</span><span class="p">(</span>
+ <span class="o">**</span><span class="n">_retry_args</span>
+ <span class="p">)</span>
+
+ <span class="bp">self</span><span class="o">.</span><span class="n">_retry_obj</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">run</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span></div></div>
</pre></div>
</div>
- <div class="articleComments">
-
- </div>
+
</div>
<footer>
@@ -309,7 +369,7 @@
</p>
</div>
- Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+ 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>
@@ -328,6 +388,7 @@
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../../',
VERSION:'',
+ LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
@@ -340,19 +401,13 @@
-
-
- <script type="text/javascript" src="../../../_static/js/theme.js"></script>
-
+ <script type="text/javascript" src="../../../_static/js/theme.js"></script>
-
-
<script type="text/javascript">
jQuery(function () {
- SphinxRtdTheme.StickyNav.enable();
+ SphinxRtdTheme.Navigation.enable(true);
});
- </script>
-
+ </script>
</body>
</html>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-airflow-site/blob/7d4d7628/_modules/airflow/hooks/jdbc_hook.html
----------------------------------------------------------------------
diff --git a/_modules/airflow/hooks/jdbc_hook.html b/_modules/airflow/hooks/jdbc_hook.html
new file mode 100644
index 0000000..74ac6c2
--- /dev/null
+++ b/_modules/airflow/hooks/jdbc_hook.html
@@ -0,0 +1,279 @@
+
+
+<!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="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 src="../../../_static/js/modernizr.min.js"></script>
+
+</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 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="../../../lineage.html">Lineage</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="../../../code.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>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="k">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="k">import</span> <span class="n">DbApiHook</span>
+
+
+<div class="viewcode-block" id="JdbcHook"><a class="viewcode-back" href="../../../code.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>
+
+ <span class="n">conn_name_attr</span> <span class="o">=</span> <span class="s1">'jdbc_conn_id'</span>
+ <span class="n">default_conn_name</span> <span class="o">=</span> <span class="s1">'jdbc_default'</span>
+ <span class="n">supports_autocommit</span> <span class="o">=</span> <span class="kc">True</span>
+
+<div class="viewcode-block" id="JdbcHook.get_conn"><a class="viewcode-back" href="../../../code.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="../../../code.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"> :return:</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>
+</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">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../../../',
+ VERSION:'',
+ LANGUAGE:'None',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </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/js/theme.js"></script>
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.Navigation.enable(true);
+ });
+ </script>
+
+</body>
+</html>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-airflow-site/blob/7d4d7628/_modules/airflow/hooks/mssql_hook.html
----------------------------------------------------------------------
diff --git a/_modules/airflow/hooks/mssql_hook.html b/_modules/airflow/hooks/mssql_hook.html
index dfb4ce8..7fa2d93 100644
--- a/_modules/airflow/hooks/mssql_hook.html
+++ b/_modules/airflow/hooks/mssql_hook.html
@@ -24,26 +24,17 @@
-
-
- <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
-
-
-
-
-
- <link rel="index" title="Index"
- href="../../../genindex.html"/>
- <link rel="search" title="Search" href="../../../search.html"/>
- <link rel="top" title="Airflow Documentation" href="../../../index.html"/>
- <link rel="up" title="Module code" href="../../index.html"/>
+ <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 src="../../../_static/js/modernizr.min.js"></script>
</head>
-<body class="wy-body-for-nav" role="document">
+<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
@@ -116,7 +107,7 @@
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
- <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <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>
@@ -124,9 +115,10 @@
</nav>
-
<div class="wy-nav-content">
+
<div class="rst-content">
+
@@ -156,8 +148,6 @@
<li class="wy-breadcrumbs-aside">
-
-
</li>
</ul>
@@ -178,9 +168,9 @@
<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">#</span>
<span class="c1"># http://www.apache.org/licenses/LICENSE-2.0</span>
-<span class="c1"># </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>
@@ -219,14 +209,12 @@
<span class="n">port</span><span class="o">=</span><span class="n">conn</span><span class="o">.</span><span class="n">port</span><span class="p">)</span>
<span class="k">return</span> <span class="n">conn</span></div>
- <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="n">conn</span><span class="o">.</span><span class="n">autocommit</span><span class="p">(</span><span class="n">autocommit</span><span class="p">)</span></div>
+<div class="viewcode-block" id="MsSqlHook.set_autocommit"><a class="viewcode-back" href="../../../code.html#airflow.hooks.mssql_hook.MsSqlHook.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="n">conn</span><span class="o">.</span><span class="n">autocommit</span><span class="p">(</span><span class="n">autocommit</span><span class="p">)</span></div></div>
</pre></div>
</div>
- <div class="articleComments">
-
- </div>
+
</div>
<footer>
@@ -238,7 +226,7 @@
</p>
</div>
- Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+ 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>
@@ -257,6 +245,7 @@
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../../',
VERSION:'',
+ LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
@@ -269,19 +258,13 @@
-
-
- <script type="text/javascript" src="../../../_static/js/theme.js"></script>
-
+ <script type="text/javascript" src="../../../_static/js/theme.js"></script>
-
-
<script type="text/javascript">
jQuery(function () {
- SphinxRtdTheme.StickyNav.enable();
+ SphinxRtdTheme.Navigation.enable(true);
});
- </script>
-
+ </script>
</body>
</html>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-airflow-site/blob/7d4d7628/_modules/airflow/hooks/mysql_hook.html
----------------------------------------------------------------------
diff --git a/_modules/airflow/hooks/mysql_hook.html b/_modules/airflow/hooks/mysql_hook.html
index ae309f5..e92fdcd 100644
--- a/_modules/airflow/hooks/mysql_hook.html
+++ b/_modules/airflow/hooks/mysql_hook.html
@@ -24,26 +24,17 @@
-
-
- <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
-
-
-
-
-
- <link rel="index" title="Index"
- href="../../../genindex.html"/>
- <link rel="search" title="Search" href="../../../search.html"/>
- <link rel="top" title="Airflow Documentation" href="../../../index.html"/>
- <link rel="up" title="Module code" href="../../index.html"/>
+ <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 src="../../../_static/js/modernizr.min.js"></script>
</head>
-<body class="wy-body-for-nav" role="document">
+<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
@@ -116,7 +107,7 @@
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
- <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <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>
@@ -124,9 +115,10 @@
</nav>
-
<div class="wy-nav-content">
+
<div class="rst-content">
+
@@ -156,8 +148,6 @@
<li class="wy-breadcrumbs-aside">
-
-
</li>
</ul>
@@ -178,9 +168,9 @@
<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">#</span>
<span class="c1"># http://www.apache.org/licenses/LICENSE-2.0</span>
-<span class="c1"># </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>
@@ -211,6 +201,22 @@
<span class="nb">super</span><span class="p">(</span><span class="n">MySqlHook</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">schema</span> <span class="o">=</span> <span class="n">kwargs</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s2">"schema"</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
+<div class="viewcode-block" id="MySqlHook.set_autocommit"><a class="viewcode-back" href="../../../code.html#airflow.hooks.mysql_hook.MySqlHook.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"> MySql connection sets autocommit in a different way.</span>
+<span class="sd"> """</span>
+ <span class="n">conn</span><span class="o">.</span><span class="n">autocommit</span><span class="p">(</span><span class="n">autocommit</span><span class="p">)</span></div>
+
+<div class="viewcode-block" id="MySqlHook.get_autocommit"><a class="viewcode-back" href="../../../code.html#airflow.hooks.mysql_hook.MySqlHook.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"> MySql connection gets autocommit in a different way.</span>
+<span class="sd"> :param conn: connection to get autocommit setting from.</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">get_autocommit</span><span class="p">()</span></div>
+
<div class="viewcode-block" id="MySqlHook.get_conn"><a class="viewcode-back" href="../../../code.html#airflow.hooks.mysql_hook.MySqlHook.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="sd">"""</span>
<span class="sd"> Returns a mysql connection object</span>
@@ -240,7 +246,7 @@
<span class="n">conn_config</span><span class="p">[</span><span class="s2">"cursorclass"</span><span class="p">]</span> <span class="o">=</span> <span class="n">MySQLdb</span><span class="o">.</span><span class="n">cursors</span><span class="o">.</span><span class="n">DictCursor</span>
<span class="k">elif</span> <span class="p">(</span><span class="n">conn</span><span class="o">.</span><span class="n">extra_dejson</span><span class="p">[</span><span class="s2">"cursor"</span><span class="p">])</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="o">==</span> <span class="s1">'ssdictcursor'</span><span class="p">:</span>
<span class="n">conn_config</span><span class="p">[</span><span class="s2">"cursorclass"</span><span class="p">]</span> <span class="o">=</span> <span class="n">MySQLdb</span><span class="o">.</span><span class="n">cursors</span><span class="o">.</span><span class="n">SSDictCursor</span>
- <span class="n">local_infile</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">'local_infile'</span><span class="p">,</span><span class="kc">False</span><span class="p">)</span>
+ <span class="n">local_infile</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">'local_infile'</span><span class="p">,</span> <span class="kc">False</span><span class="p">)</span>
<span class="k">if</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">'ssl'</span><span class="p">,</span> <span class="kc">False</span><span class="p">):</span>
<span class="n">conn_config</span><span class="p">[</span><span class="s1">'ssl'</span><span class="p">]</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">extra_dejson</span><span class="p">[</span><span class="s1">'ssl'</span><span class="p">]</span>
<span class="k">if</span> <span class="n">local_infile</span><span class="p">:</span>
@@ -260,11 +266,23 @@
<span class="s2"> """</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="o">**</span><span class="nb">locals</span><span class="p">()))</span>
<span class="n">conn</span><span class="o">.</span><span class="n">commit</span><span class="p">()</span></div>
+<div class="viewcode-block" id="MySqlHook.bulk_dump"><a class="viewcode-back" href="../../../code.html#airflow.hooks.mysql_hook.MySqlHook.bulk_dump">[docs]</a> <span class="k">def</span> <span class="nf">bulk_dump</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">table</span><span class="p">,</span> <span class="n">tmp_file</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Dumps a database table into a tab-delimited file</span>
+<span class="sd"> """</span>
+ <span class="n">conn</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span>
+ <span class="n">cur</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">cursor</span><span class="p">()</span>
+ <span class="n">cur</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s2">"""</span>
+<span class="s2"> SELECT * INTO OUTFILE '</span><span class="si">{tmp_file}</span><span class="s2">'</span>
+<span class="s2"> FROM </span><span class="si">{table}</span><span class="s2"></span>
+<span class="s2"> """</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="o">**</span><span class="nb">locals</span><span class="p">()))</span>
+ <span class="n">conn</span><span class="o">.</span><span class="n">commit</span><span class="p">()</span></div>
+
<span class="nd">@staticmethod</span>
<span class="k">def</span> <span class="nf">_serialize_cell</span><span class="p">(</span><span class="n">cell</span><span class="p">,</span> <span class="n">conn</span><span class="p">):</span>
<span class="sd">"""</span>
-<span class="sd"> MySQLdb converts an argument to a literal when passing those seperately to execute.</span>
-<span class="sd"> Hence, this method does nothing.</span>
+<span class="sd"> MySQLdb converts an argument to a literal</span>
+<span class="sd"> when passing those seperately to execute. Hence, this method does nothing.</span>
<span class="sd"> :param cell: The cell to insert into the table</span>
<span class="sd"> :type cell: object</span>
@@ -278,9 +296,7 @@
</pre></div>
</div>
- <div class="articleComments">
-
- </div>
+
</div>
<footer>
@@ -292,7 +308,7 @@
</p>
</div>
- Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+ 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>
@@ -311,6 +327,7 @@
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../../',
VERSION:'',
+ LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
@@ -323,19 +340,13 @@
-
-
- <script type="text/javascript" src="../../../_static/js/theme.js"></script>
-
+ <script type="text/javascript" src="../../../_static/js/theme.js"></script>
-
-
<script type="text/javascript">
jQuery(function () {
- SphinxRtdTheme.StickyNav.enable();
+ SphinxRtdTheme.Navigation.enable(true);
});
- </script>
-
+ </script>
</body>
</html>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-airflow-site/blob/7d4d7628/_modules/airflow/hooks/oracle_hook.html
----------------------------------------------------------------------
diff --git a/_modules/airflow/hooks/oracle_hook.html b/_modules/airflow/hooks/oracle_hook.html
index 3683348..15bd166 100644
--- a/_modules/airflow/hooks/oracle_hook.html
+++ b/_modules/airflow/hooks/oracle_hook.html
@@ -24,26 +24,17 @@
-
-
- <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
-
-
-
-
-
- <link rel="index" title="Index"
- href="../../../genindex.html"/>
- <link rel="search" title="Search" href="../../../search.html"/>
- <link rel="top" title="Airflow Documentation" href="../../../index.html"/>
- <link rel="up" title="Module code" href="../../index.html"/>
+ <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 src="../../../_static/js/modernizr.min.js"></script>
</head>
-<body class="wy-body-for-nav" role="document">
+<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
@@ -116,7 +107,7 @@
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
- <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <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>
@@ -124,9 +115,10 @@
</nav>
-
<div class="wy-nav-content">
+
<div class="rst-content">
+
@@ -156,8 +148,6 @@
<li class="wy-breadcrumbs-aside">
-
-
</li>
</ul>
@@ -178,9 +168,9 @@
<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">#</span>
<span class="c1"># http://www.apache.org/licenses/LICENSE-2.0</span>
-<span class="c1"># </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>
@@ -208,12 +198,15 @@
<div class="viewcode-block" id="OracleHook.get_conn"><a class="viewcode-back" href="../../../code.html#airflow.hooks.oracle_hook.OracleHook.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="sd">"""</span>
<span class="sd"> Returns a oracle connection object</span>
-<span class="sd"> Optional parameters for using a custom DSN connection (instead of using a server alias from tnsnames.ora)</span>
-<span class="sd"> The dsn (data source name) is the TNS entry (from the Oracle names server or tnsnames.ora file)</span>
+<span class="sd"> Optional parameters for using a custom DSN connection</span>
+<span class="sd"> (instead of using a server alias from tnsnames.ora)</span>
+<span class="sd"> The dsn (data source name) is the TNS entry</span>
+<span class="sd"> (from the Oracle names server or tnsnames.ora file)</span>
<span class="sd"> or is a string like the one returned from makedsn().</span>
<span class="sd"> :param dsn: the host address for the Oracle server</span>
-<span class="sd"> :param service_name: the db_unique_name of the database that you are connecting to (CONNECT_DATA part of TNS)</span>
+<span class="sd"> :param service_name: the db_unique_name of the database</span>
+<span class="sd"> that you are connecting to (CONNECT_DATA part of TNS)</span>
<span class="sd"> You can set these parameters in the extra fields of your connection</span>
<span class="sd"> as in ``{ "dsn":"some.host.address" , "service_name":"some.service.name" }``</span>
<span class="sd"> """</span>
@@ -243,7 +236,8 @@
<span class="sd"> the whole set of inserts is treated as one transaction</span>
<span class="sd"> Changes from standard DbApiHook implementation:</span>
<span class="sd"> - Oracle SQL queries in cx_Oracle can not be terminated with a semicolon (';')</span>
-<span class="sd"> - Replace NaN values with NULL using numpy.nan_to_num (not using is_nan() because of input types error for strings)</span>
+<span class="sd"> - Replace NaN values with NULL using numpy.nan_to_num (not using is_nan()</span>
+<span class="sd"> because of input types error for strings)</span>
<span class="sd"> - Coerce datetime cells to Oracle DATETIME format during insert</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">target_fields</span><span class="p">:</span>
@@ -259,22 +253,28 @@
<span class="n">i</span> <span class="o">=</span> <span class="mi">0</span>
<span class="k">for</span> <span class="n">row</span> <span class="ow">in</span> <span class="n">rows</span><span class="p">:</span>
<span class="n">i</span> <span class="o">+=</span> <span class="mi">1</span>
- <span class="n">l</span> <span class="o">=</span> <span class="p">[]</span>
+ <span class="n">lst</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">cell</span> <span class="ow">in</span> <span class="n">row</span><span class="p">:</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">cell</span><span class="p">,</span> <span class="n">basestring</span><span class="p">):</span>
- <span class="n">l</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s2">"'"</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">cell</span><span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s2">"'"</span><span class="p">,</span> <span class="s2">"''"</span><span class="p">)</span> <span class="o">+</span> <span class="s2">"'"</span><span class="p">)</span>
+ <span class="n">lst</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s2">"'"</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">cell</span><span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s2">"'"</span><span class="p">,</span> <span class="s2">"''"</span><span class="p">)</span> <span class="o">+</span> <span class="s2">"'"</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">cell</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
- <span class="n">l</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s1">'NULL'</span><span class="p">)</span>
- <span class="k">elif</span> <span class="nb">type</span><span class="p">(</span><span class="n">cell</span><span class="p">)</span> <span class="o">==</span> <span class="nb">float</span> <span class="ow">and</span> <span class="n">numpy</span><span class="o">.</span><span class="n">isnan</span><span class="p">(</span><span class="n">cell</span><span class="p">):</span> <span class="c1"># coerce numpy NaN to NULL</span>
- <span class="n">l</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s1">'NULL'</span><span class="p">)</span>
+ <span class="n">lst</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s1">'NULL'</span><span class="p">)</span>
+ <span class="k">elif</span> <span class="nb">type</span><span class="p">(</span><span class="n">cell</span><span class="p">)</span> <span class="o">==</span> <span class="nb">float</span> <span class="ow">and</span> \
+ <span class="n">numpy</span><span class="o">.</span><span class="n">isnan</span><span class="p">(</span><span class="n">cell</span><span class="p">):</span> <span class="c1"># coerce numpy NaN to NULL</span>
+ <span class="n">lst</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s1">'NULL'</span><span class="p">)</span>
<span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">cell</span><span class="p">,</span> <span class="n">numpy</span><span class="o">.</span><span class="n">datetime64</span><span class="p">):</span>
- <span class="n">l</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s2">"'"</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">cell</span><span class="p">)</span> <span class="o">+</span> <span class="s2">"'"</span><span class="p">)</span>
+ <span class="n">lst</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s2">"'"</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">cell</span><span class="p">)</span> <span class="o">+</span> <span class="s2">"'"</span><span class="p">)</span>
<span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">cell</span><span class="p">,</span> <span class="n">datetime</span><span class="p">):</span>
- <span class="n">l</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s2">"to_date('"</span> <span class="o">+</span> <span class="n">cell</span><span class="o">.</span><span class="n">strftime</span><span class="p">(</span><span class="s1">'%Y-%m-</span><span class="si">%d</span><span class="s1"> %H:%M:%S'</span><span class="p">)</span> <span class="o">+</span> <span class="s2">"','YYYY-MM-DD HH24:MI:SS')"</span><span class="p">)</span>
+ <span class="n">lst</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s2">"to_date('"</span> <span class="o">+</span>
+ <span class="n">cell</span><span class="o">.</span><span class="n">strftime</span><span class="p">(</span><span class="s1">'%Y-%m-</span><span class="si">%d</span><span class="s1"> %H:%M:%S'</span><span class="p">)</span> <span class="o">+</span>
+ <span class="s2">"','YYYY-MM-DD HH24:MI:SS')"</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
- <span class="n">l</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">cell</span><span class="p">))</span>
- <span class="n">values</span> <span class="o">=</span> <span class="nb">tuple</span><span class="p">(</span><span class="n">l</span><span class="p">)</span>
- <span class="n">sql</span> <span class="o">=</span> <span class="s1">'INSERT /*+ APPEND */ INTO </span><span class="si">{0}</span><span class="s1"> </span><span class="si">{1}</span><span class="s1"> VALUES (</span><span class="si">{2}</span><span class="s1">)'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">table</span><span class="p">,</span> <span class="n">target_fields</span><span class="p">,</span> <span class="s1">','</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">values</span><span class="p">))</span>
+ <span class="n">lst</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">cell</span><span class="p">))</span>
+ <span class="n">values</span> <span class="o">=</span> <span class="nb">tuple</span><span class="p">(</span><span class="n">lst</span><span class="p">)</span>
+ <span class="n">sql</span> <span class="o">=</span> <span class="s1">'INSERT /*+ APPEND */ '</span> \
+ <span class="s1">'INTO </span><span class="si">{0}</span><span class="s1"> </span><span class="si">{1}</span><span class="s1"> VALUES (</span><span class="si">{2}</span><span class="s1">)'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">table</span><span class="p">,</span>
+ <span class="n">target_fields</span><span class="p">,</span>
+ <span class="s1">','</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">values</span><span class="p">))</span>
<span class="n">cur</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">sql</span><span class="p">)</span>
<span class="k">if</span> <span class="n">i</span> <span class="o">%</span> <span class="n">commit_every</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="n">conn</span><span class="o">.</span><span class="n">commit</span><span class="p">()</span>
@@ -285,7 +285,9 @@
<span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s1">'Done loading. Loaded a total of </span><span class="si">{i}</span><span class="s1"> rows'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="o">**</span><span class="nb">locals</span><span class="p">()))</span></div>
<div class="viewcode-block" id="OracleHook.bulk_insert_rows"><a class="viewcode-back" href="../../../code.html#airflow.hooks.oracle_hook.OracleHook.bulk_insert_rows">[docs]</a> <span class="k">def</span> <span class="nf">bulk_insert_rows</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">table</span><span class="p">,</span> <span class="n">rows</span><span class="p">,</span> <span class="n">target_fields</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">commit_every</span><span class="o">=</span><span class="mi">5000</span><span class="p">):</span>
- <span class="sd">"""A performant bulk insert for cx_Oracle that uses prepared statements via `executemany()`.</span>
+ <span class="sd">"""</span>
+<span class="sd"> A performant bulk insert for cx_Oracle</span>
+<span class="sd"> that uses prepared statements via `executemany()`.</span>
<span class="sd"> For best performance, pass in `rows` as an iterator.</span>
<span class="sd"> """</span>
<span class="n">conn</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span>
@@ -319,9 +321,7 @@
</pre></div>
</div>
- <div class="articleComments">
-
- </div>
+
</div>
<footer>
@@ -333,7 +333,7 @@
</p>
</div>
- Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+ 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>
@@ -352,6 +352,7 @@
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../../',
VERSION:'',
+ LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
@@ -364,19 +365,13 @@
-
-
- <script type="text/javascript" src="../../../_static/js/theme.js"></script>
-
+ <script type="text/javascript" src="../../../_static/js/theme.js"></script>
-
-
<script type="text/javascript">
jQuery(function () {
- SphinxRtdTheme.StickyNav.enable();
+ SphinxRtdTheme.Navigation.enable(true);
});
- </script>
-
+ </script>
</body>
</html>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-airflow-site/blob/7d4d7628/_modules/airflow/hooks/pig_hook.html
----------------------------------------------------------------------
diff --git a/_modules/airflow/hooks/pig_hook.html b/_modules/airflow/hooks/pig_hook.html
index 05fac3c..0d20585 100644
--- a/_modules/airflow/hooks/pig_hook.html
+++ b/_modules/airflow/hooks/pig_hook.html
@@ -24,26 +24,17 @@
-
-
- <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
-
-
-
-
-
- <link rel="index" title="Index"
- href="../../../genindex.html"/>
- <link rel="search" title="Search" href="../../../search.html"/>
- <link rel="top" title="Airflow Documentation" href="../../../index.html"/>
- <link rel="up" title="Module code" href="../../index.html"/>
+ <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 src="../../../_static/js/modernizr.min.js"></script>
</head>
-<body class="wy-body-for-nav" role="document">
+<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
@@ -116,7 +107,7 @@
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
- <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <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>
@@ -124,9 +115,10 @@
</nav>
-
<div class="wy-nav-content">
+
<div class="rst-content">
+
@@ -156,8 +148,6 @@
<li class="wy-breadcrumbs-aside">
-
-
</li>
</ul>
@@ -178,9 +168,9 @@
<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">#</span>
<span class="c1"># http://www.apache.org/licenses/LICENSE-2.0</span>
-<span class="c1"># </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>
@@ -266,9 +256,7 @@
</pre></div>
</div>
- <div class="articleComments">
-
- </div>
+
</div>
<footer>
@@ -280,7 +268,7 @@
</p>
</div>
- Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+ 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>
@@ -299,6 +287,7 @@
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../../',
VERSION:'',
+ LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
@@ -311,19 +300,13 @@
-
-
- <script type="text/javascript" src="../../../_static/js/theme.js"></script>
-
+ <script type="text/javascript" src="../../../_static/js/theme.js"></script>
-
-
<script type="text/javascript">
jQuery(function () {
- SphinxRtdTheme.StickyNav.enable();
+ SphinxRtdTheme.Navigation.enable(true);
});
- </script>
-
+ </script>
</body>
</html>
\ No newline at end of file