| |
| |
| |
| |
| |
| <!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.oracle_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> |
| <script type="text/javascript"> |
| var _gaq = _gaq || []; |
| _gaq.push(['_setAccount', 'UA-140539454-1']); |
| _gaq.push(['_trackPageview']); |
| </script> |
| <style> |
| .example-header { |
| position: relative; |
| background: #9AAA7A; |
| padding: 8px 16px; |
| margin-bottom: 0; |
| } |
| .example-header--with-button { |
| padding-right: 166px; |
| } |
| .example-header:after{ |
| content: ''; |
| display: table; |
| clear: both; |
| } |
| .example-title { |
| display:block; |
| padding: 4px; |
| margin-right: 16px; |
| color: white; |
| overflow-x: auto; |
| } |
| .example-header-button { |
| top: 8px; |
| right: 16px; |
| position: absolute; |
| } |
| .example-header + .highlight-python { |
| margin-top: 0 !important; |
| } |
| .viewcode-button { |
| display: inline-block; |
| padding: 8px 16px; |
| border: 0; |
| margin: 0; |
| outline: 0; |
| border-radius: 2px; |
| -webkit-box-shadow: 0 3px 5px 0 rgba(0,0,0,.3); |
| box-shadow: 0 3px 6px 0 rgba(0,0,0,.3); |
| color: #404040; |
| background-color: #e7e7e7; |
| cursor: pointer; |
| font-size: 16px; |
| font-weight: 500; |
| line-height: 1; |
| text-decoration: none; |
| text-overflow: ellipsis; |
| overflow: hidden; |
| text-transform: uppercase; |
| -webkit-transition: background-color .2s; |
| transition: background-color .2s; |
| vertical-align: middle; |
| white-space: nowrap; |
| } |
| .viewcode-button:visited { |
| color: #404040; |
| } |
| .viewcode-button:hover, .viewcode-button:focus { |
| color: #404040; |
| background-color: #d6d6d6; |
| } |
| </style> |
| |
| </head> |
| |
| <body class="wy-body-for-nav"> |
| |
| |
| <div class="wy-grid-for-nav"> |
| |
| <nav data-toggle="wy-nav-shift" class="wy-nav-side"> |
| <div class="wy-side-scroll"> |
| <div class="wy-side-nav-search" > |
| |
| |
| |
| <a href="../../../index.html" class="icon icon-home"> Airflow |
| |
| |
| |
| </a> |
| |
| |
| |
| |
| <div class="version"> |
| 1.10.5 |
| </div> |
| |
| |
| |
| |
| <div role="search"> |
| <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get"> |
| <input type="text" name="q" placeholder="Search docs" /> |
| <input type="hidden" name="check_keywords" value="yes" /> |
| <input type="hidden" name="area" value="default" /> |
| </form> |
| </div> |
| |
| |
| </div> |
| |
| <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> |
| |
| |
| |
| |
| |
| |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="../../../project.html">Project</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../license.html">License</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../start.html">Quick Start</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../installation.html">Installation</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../tutorial.html">Tutorial</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../howto/index.html">How-to Guides</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../ui.html">UI / Screenshots</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../concepts.html">Concepts</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../profiling.html">Data Profiling</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../cli.html">Command Line Interface Reference</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../scheduler.html">Scheduling & Triggers</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../plugins.html">Plugins</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../security.html">Security</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../timezone.html">Time zones</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../api.html">REST API Reference</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../integration.html">Integration</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../metrics.html">Metrics</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../kubernetes.html">Kubernetes</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../lineage.html">Lineage</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../changelog.html">Changelog</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../faq.html">FAQ</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../macros.html">Macros reference</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../_api/index.html">Python API Reference</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../privacy_notice.html">Privacy Notice</a></li> |
| </ul> |
| |
| |
| |
| </div> |
| </div> |
| </nav> |
| |
| <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> |
| |
| |
| <nav class="wy-nav-top" aria-label="top navigation"> |
| |
| <i data-toggle="wy-nav-top" class="fa fa-bars"></i> |
| <a href="../../../index.html">Airflow</a> |
| |
| </nav> |
| |
| |
| <div class="wy-nav-content"> |
| |
| <div class="rst-content"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div role="navigation" aria-label="breadcrumbs navigation"> |
| |
| <ul class="wy-breadcrumbs"> |
| |
| <li><a href="../../../index.html">Docs</a> »</li> |
| |
| <li><a href="../../index.html">Module code</a> »</li> |
| |
| <li><a href="../hooks.html">airflow.hooks</a> »</li> |
| |
| <li>airflow.hooks.oracle_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.oracle_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">import</span> <span class="nn">cx_Oracle</span> |
| |
| <span class="kn">from</span> <span class="nn">airflow.hooks.dbapi_hook</span> <span class="k">import</span> <span class="n">DbApiHook</span> |
| <span class="kn">from</span> <span class="nn">builtins</span> <span class="k">import</span> <span class="nb">str</span> |
| <span class="kn">from</span> <span class="nn">past.builtins</span> <span class="k">import</span> <span class="n">basestring</span> |
| <span class="kn">from</span> <span class="nn">datetime</span> <span class="k">import</span> <span class="n">datetime</span> |
| <span class="kn">import</span> <span class="nn">numpy</span> |
| |
| |
| <div class="viewcode-block" id="OracleHook"><a class="viewcode-back" href="../../../_api/airflow/hooks/oracle_hook/index.html#airflow.hooks.oracle_hook.OracleHook">[docs]</a><span class="k">class</span> <span class="nc">OracleHook</span><span class="p">(</span><span class="n">DbApiHook</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Interact with Oracle SQL.</span> |
| <span class="sd"> """</span> |
| <div class="viewcode-block" id="OracleHook.conn_name_attr"><a class="viewcode-back" href="../../../_api/airflow/hooks/oracle_hook/index.html#airflow.hooks.oracle_hook.OracleHook.conn_name_attr">[docs]</a> <span class="n">conn_name_attr</span> <span class="o">=</span> <span class="s1">'oracle_conn_id'</span></div> |
| <div class="viewcode-block" id="OracleHook.default_conn_name"><a class="viewcode-back" href="../../../_api/airflow/hooks/oracle_hook/index.html#airflow.hooks.oracle_hook.OracleHook.default_conn_name">[docs]</a> <span class="n">default_conn_name</span> <span class="o">=</span> <span class="s1">'oracle_default'</span></div> |
| <div class="viewcode-block" id="OracleHook.supports_autocommit"><a class="viewcode-back" href="../../../_api/airflow/hooks/oracle_hook/index.html#airflow.hooks.oracle_hook.OracleHook.supports_autocommit">[docs]</a> <span class="n">supports_autocommit</span> <span class="o">=</span> <span class="kc">False</span></div> |
| |
| <div class="viewcode-block" id="OracleHook.get_conn"><a class="viewcode-back" href="../../../_api/airflow/hooks/oracle_hook/index.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</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</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"> see more param detail in</span> |
| <span class="sd"> `cx_Oracle.connect <https://cx-oracle.readthedocs.io/en/latest/module.html#cx_Oracle.connect>`_</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">oracle_conn_id</span><span class="p">)</span> |
| <span class="n">conn_config</span> <span class="o">=</span> <span class="p">{</span> |
| <span class="s1">'user'</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="s1">'password'</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="n">dsn</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">'dsn'</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span> |
| <span class="n">sid</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">'sid'</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span> |
| <span class="n">mod</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">'module'</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span> |
| |
| <span class="n">service_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">'service_name'</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span> |
| <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="k">if</span> <span class="n">conn</span><span class="o">.</span><span class="n">port</span> <span class="k">else</span> <span class="mi">1521</span> |
| <span class="k">if</span> <span class="n">dsn</span> <span class="ow">and</span> <span class="n">sid</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">service_name</span><span class="p">:</span> |
| <span class="n">conn_config</span><span class="p">[</span><span class="s1">'dsn'</span><span class="p">]</span> <span class="o">=</span> <span class="n">cx_Oracle</span><span class="o">.</span><span class="n">makedsn</span><span class="p">(</span><span class="n">dsn</span><span class="p">,</span> <span class="n">port</span><span class="p">,</span> <span class="n">sid</span><span class="p">)</span> |
| <span class="k">elif</span> <span class="n">dsn</span> <span class="ow">and</span> <span class="n">service_name</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">sid</span><span class="p">:</span> |
| <span class="n">conn_config</span><span class="p">[</span><span class="s1">'dsn'</span><span class="p">]</span> <span class="o">=</span> <span class="n">cx_Oracle</span><span class="o">.</span><span class="n">makedsn</span><span class="p">(</span><span class="n">dsn</span><span class="p">,</span> <span class="n">port</span><span class="p">,</span> <span class="n">service_name</span><span class="o">=</span><span class="n">service_name</span><span class="p">)</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="n">conn_config</span><span class="p">[</span><span class="s1">'dsn'</span><span class="p">]</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="s1">'encoding'</span> <span class="ow">in</span> <span class="n">conn</span><span class="o">.</span><span class="n">extra_dejson</span><span class="p">:</span> |
| <span class="n">conn_config</span><span class="p">[</span><span class="s1">'encoding'</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="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'encoding'</span><span class="p">)</span> |
| <span class="c1"># if `encoding` is specific but `nencoding` is not</span> |
| <span class="c1"># `nencoding` should use same values as `encoding` to set encoding, inspired by</span> |
| <span class="c1"># https://github.com/oracle/python-cx_Oracle/issues/157#issuecomment-371877993</span> |
| <span class="k">if</span> <span class="s1">'nencoding'</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">conn</span><span class="o">.</span><span class="n">extra_dejson</span><span class="p">:</span> |
| <span class="n">conn_config</span><span class="p">[</span><span class="s1">'nencoding'</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="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'encoding'</span><span class="p">)</span> |
| <span class="k">if</span> <span class="s1">'nencoding'</span> <span class="ow">in</span> <span class="n">conn</span><span class="o">.</span><span class="n">extra_dejson</span><span class="p">:</span> |
| <span class="n">conn_config</span><span class="p">[</span><span class="s1">'nencoding'</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="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'nencoding'</span><span class="p">)</span> |
| <span class="k">if</span> <span class="s1">'threaded'</span> <span class="ow">in</span> <span class="n">conn</span><span class="o">.</span><span class="n">extra_dejson</span><span class="p">:</span> |
| <span class="n">conn_config</span><span class="p">[</span><span class="s1">'threaded'</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="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'threaded'</span><span class="p">)</span> |
| <span class="k">if</span> <span class="s1">'events'</span> <span class="ow">in</span> <span class="n">conn</span><span class="o">.</span><span class="n">extra_dejson</span><span class="p">:</span> |
| <span class="n">conn_config</span><span class="p">[</span><span class="s1">'events'</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="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'events'</span><span class="p">)</span> |
| |
| <span class="n">mode</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">'mode'</span><span class="p">,</span> <span class="s1">''</span><span class="p">)</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> |
| <span class="k">if</span> <span class="n">mode</span> <span class="o">==</span> <span class="s1">'sysdba'</span><span class="p">:</span> |
| <span class="n">conn_config</span><span class="p">[</span><span class="s1">'mode'</span><span class="p">]</span> <span class="o">=</span> <span class="n">cx_Oracle</span><span class="o">.</span><span class="n">SYSDBA</span> |
| <span class="k">elif</span> <span class="n">mode</span> <span class="o">==</span> <span class="s1">'sysasm'</span><span class="p">:</span> |
| <span class="n">conn_config</span><span class="p">[</span><span class="s1">'mode'</span><span class="p">]</span> <span class="o">=</span> <span class="n">cx_Oracle</span><span class="o">.</span><span class="n">SYSASM</span> |
| <span class="k">elif</span> <span class="n">mode</span> <span class="o">==</span> <span class="s1">'sysoper'</span><span class="p">:</span> |
| <span class="n">conn_config</span><span class="p">[</span><span class="s1">'mode'</span><span class="p">]</span> <span class="o">=</span> <span class="n">cx_Oracle</span><span class="o">.</span><span class="n">SYSOPER</span> |
| <span class="k">elif</span> <span class="n">mode</span> <span class="o">==</span> <span class="s1">'sysbkp'</span><span class="p">:</span> |
| <span class="n">conn_config</span><span class="p">[</span><span class="s1">'mode'</span><span class="p">]</span> <span class="o">=</span> <span class="n">cx_Oracle</span><span class="o">.</span><span class="n">SYSBKP</span> |
| <span class="k">elif</span> <span class="n">mode</span> <span class="o">==</span> <span class="s1">'sysdgd'</span><span class="p">:</span> |
| <span class="n">conn_config</span><span class="p">[</span><span class="s1">'mode'</span><span class="p">]</span> <span class="o">=</span> <span class="n">cx_Oracle</span><span class="o">.</span><span class="n">SYSDGD</span> |
| <span class="k">elif</span> <span class="n">mode</span> <span class="o">==</span> <span class="s1">'syskmt'</span><span class="p">:</span> |
| <span class="n">conn_config</span><span class="p">[</span><span class="s1">'mode'</span><span class="p">]</span> <span class="o">=</span> <span class="n">cx_Oracle</span><span class="o">.</span><span class="n">SYSKMT</span> |
| <span class="k">elif</span> <span class="n">mode</span> <span class="o">==</span> <span class="s1">'sysrac'</span><span class="p">:</span> |
| <span class="n">conn_config</span><span class="p">[</span><span class="s1">'mode'</span><span class="p">]</span> <span class="o">=</span> <span class="n">cx_Oracle</span><span class="o">.</span><span class="n">SYSRAC</span> |
| |
| <span class="n">purity</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">'purity'</span><span class="p">,</span> <span class="s1">''</span><span class="p">)</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> |
| <span class="k">if</span> <span class="n">purity</span> <span class="o">==</span> <span class="s1">'new'</span><span class="p">:</span> |
| <span class="n">conn_config</span><span class="p">[</span><span class="s1">'purity'</span><span class="p">]</span> <span class="o">=</span> <span class="n">cx_Oracle</span><span class="o">.</span><span class="n">ATTR_PURITY_NEW</span> |
| <span class="k">elif</span> <span class="n">purity</span> <span class="o">==</span> <span class="s1">'self'</span><span class="p">:</span> |
| <span class="n">conn_config</span><span class="p">[</span><span class="s1">'purity'</span><span class="p">]</span> <span class="o">=</span> <span class="n">cx_Oracle</span><span class="o">.</span><span class="n">ATTR_PURITY_SELF</span> |
| <span class="k">elif</span> <span class="n">purity</span> <span class="o">==</span> <span class="s1">'default'</span><span class="p">:</span> |
| <span class="n">conn_config</span><span class="p">[</span><span class="s1">'purity'</span><span class="p">]</span> <span class="o">=</span> <span class="n">cx_Oracle</span><span class="o">.</span><span class="n">ATTR_PURITY_DEFAULT</span> |
| |
| <span class="n">conn</span> <span class="o">=</span> <span class="n">cx_Oracle</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="o">**</span><span class="n">conn_config</span><span class="p">)</span> |
| <span class="k">if</span> <span class="n">mod</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="n">conn</span><span class="o">.</span><span class="n">module</span> <span class="o">=</span> <span class="n">mod</span> |
| |
| <span class="k">return</span> <span class="n">conn</span></div> |
| |
| <div class="viewcode-block" id="OracleHook.insert_rows"><a class="viewcode-back" href="../../../_api/airflow/hooks/oracle_hook/index.html#airflow.hooks.oracle_hook.OracleHook.insert_rows">[docs]</a> <span class="k">def</span> <span class="nf">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">1000</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> A generic way to insert a set of tuples into a table,</span> |
| <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</span> |
| <span class="sd"> `is_nan()` because of input types error for strings)</span> |
| <span class="sd"> - Coerce datetime cells to Oracle DATETIME format during insert</span> |
| |
| <span class="sd"> :param table: target Oracle table, use dot notation to target a</span> |
| <span class="sd"> specific database</span> |
| <span class="sd"> :type table: str</span> |
| <span class="sd"> :param rows: the rows to insert into the table</span> |
| <span class="sd"> :type rows: iterable of tuples</span> |
| <span class="sd"> :param target_fields: the names of the columns to fill in the table</span> |
| <span class="sd"> :type target_fields: iterable of str</span> |
| <span class="sd"> :param commit_every: the maximum number of rows to insert in one transaction</span> |
| <span class="sd"> Default 1000, Set greater than 0.</span> |
| <span class="sd"> Set 1 to insert each row in each single transaction</span> |
| <span class="sd"> :type commit_every: int</span> |
| <span class="sd"> """</span> |
| <span class="k">if</span> <span class="n">target_fields</span><span class="p">:</span> |
| <span class="n">target_fields</span> <span class="o">=</span> <span class="s1">', '</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">target_fields</span><span class="p">)</span> |
| <span class="n">target_fields</span> <span class="o">=</span> <span class="s1">'(</span><span class="si">{}</span><span class="s1">)'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">target_fields</span><span class="p">)</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="n">target_fields</span> <span class="o">=</span> <span class="s1">''</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="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">supports_autocommit</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="s1">'SET autocommit = 0'</span><span class="p">)</span> |
| <span class="n">conn</span><span class="o">.</span><span class="n">commit</span><span class="p">()</span> |
| <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">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">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">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">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">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">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> |
| <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">'Loaded </span><span class="si">%s</span><span class="s1"> into </span><span class="si">%s</span><span class="s1"> rows so far'</span><span class="p">,</span> <span class="n">i</span><span class="p">,</span> <span class="n">table</span><span class="p">)</span> |
| <span class="n">conn</span><span class="o">.</span><span class="n">commit</span><span class="p">()</span> |
| <span class="n">cur</span><span class="o">.</span><span class="n">close</span><span class="p">()</span> |
| <span class="n">conn</span><span class="o">.</span><span class="n">close</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">info</span><span class="p">(</span><span class="s1">'Done loading. Loaded a total of </span><span class="si">%s</span><span class="s1"> rows'</span><span class="p">,</span> <span class="n">i</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="OracleHook.bulk_insert_rows"><a class="viewcode-back" href="../../../_api/airflow/hooks/oracle_hook/index.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">"""</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"> :param table: target Oracle table, use dot notation to target a</span> |
| <span class="sd"> specific database</span> |
| <span class="sd"> :type table: str</span> |
| <span class="sd"> :param rows: the rows to insert into the table</span> |
| <span class="sd"> :type rows: iterable of tuples</span> |
| <span class="sd"> :param target_fields: the names of the columns to fill in the table, default None.</span> |
| <span class="sd"> If None, each rows should have some order as table columns name</span> |
| <span class="sd"> :type target_fields: iterable of str Or None</span> |
| <span class="sd"> :param commit_every: the maximum number of rows to insert in one transaction</span> |
| <span class="sd"> Default 5000. Set greater than 0. Set 1 to insert each row in each transaction</span> |
| <span class="sd"> :type commit_every: int</span> |
| <span class="sd"> """</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="n">rows</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"parameter rows could not be None or empty iterable"</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_conn</span><span class="p">()</span> |
| <span class="n">cursor</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">values_base</span> <span class="o">=</span> <span class="n">target_fields</span> <span class="k">if</span> <span class="n">target_fields</span> <span class="k">else</span> <span class="n">rows</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> |
| <span class="n">prepared_stm</span> <span class="o">=</span> <span class="s1">'insert into </span><span class="si">{tablename}</span><span class="s1"> </span><span class="si">{columns}</span><span class="s1"> values (</span><span class="si">{values}</span><span class="s1">)'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span> |
| <span class="n">tablename</span><span class="o">=</span><span class="n">table</span><span class="p">,</span> |
| <span class="n">columns</span><span class="o">=</span><span class="s1">'(</span><span class="si">{}</span><span class="s1">)'</span><span class="o">.</span><span class="n">format</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">target_fields</span><span class="p">))</span> <span class="k">if</span> <span class="n">target_fields</span> <span class="k">else</span> <span class="s1">''</span><span class="p">,</span> |
| <span class="n">values</span><span class="o">=</span><span class="s1">', '</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="s1">':</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="n">i</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="nb">len</span><span class="p">(</span><span class="n">values_base</span><span class="p">)</span> <span class="o">+</span> <span class="mi">1</span><span class="p">)),</span> |
| <span class="p">)</span> |
| <span class="n">row_count</span> <span class="o">=</span> <span class="mi">0</span> |
| <span class="c1"># Chunk the rows</span> |
| <span class="n">row_chunk</span> <span class="o">=</span> <span class="p">[]</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">row_chunk</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">row</span><span class="p">)</span> |
| <span class="n">row_count</span> <span class="o">+=</span> <span class="mi">1</span> |
| <span class="k">if</span> <span class="n">row_count</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">cursor</span><span class="o">.</span><span class="n">prepare</span><span class="p">(</span><span class="n">prepared_stm</span><span class="p">)</span> |
| <span class="n">cursor</span><span class="o">.</span><span class="n">executemany</span><span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="n">row_chunk</span><span class="p">)</span> |
| <span class="n">conn</span><span class="o">.</span><span class="n">commit</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">info</span><span class="p">(</span><span class="s1">'[</span><span class="si">%s</span><span class="s1">] inserted </span><span class="si">%s</span><span class="s1"> rows'</span><span class="p">,</span> <span class="n">table</span><span class="p">,</span> <span class="n">row_count</span><span class="p">)</span> |
| <span class="c1"># Empty chunk</span> |
| <span class="n">row_chunk</span> <span class="o">=</span> <span class="p">[]</span> |
| <span class="c1"># Commit the leftover chunk</span> |
| <span class="n">cursor</span><span class="o">.</span><span class="n">prepare</span><span class="p">(</span><span class="n">prepared_stm</span><span class="p">)</span> |
| <span class="n">cursor</span><span class="o">.</span><span class="n">executemany</span><span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="n">row_chunk</span><span class="p">)</span> |
| <span class="n">conn</span><span class="o">.</span><span class="n">commit</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">info</span><span class="p">(</span><span class="s1">'[</span><span class="si">%s</span><span class="s1">] inserted </span><span class="si">%s</span><span class="s1"> rows'</span><span class="p">,</span> <span class="n">table</span><span class="p">,</span> <span class="n">row_count</span><span class="p">)</span> |
| <span class="n">cursor</span><span class="o">.</span><span class="n">close</span><span class="p">()</span> |
| <span class="n">conn</span><span class="o">.</span><span class="n">close</span><span class="p">()</span></div></div> |
| </pre></div> |
| |
| </div> |
| |
| </div> |
| |
| |
| <footer> |
| |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p> |
| |
| </p> |
| </div> |
| Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. |
| <div class="footer">This page uses <a href="https://analytics.google.com/"> |
| Google Analytics</a> to collect statistics. You can disable it by blocking |
| the JavaScript coming from www.google-analytics.com. Check our |
| <a href="../../../privacy_notice.html">Privacy Policy</a> |
| for more details. |
| <script type="text/javascript"> |
| (function() { |
| var ga = document.createElement('script'); |
| ga.src = ('https:' == document.location.protocol ? |
| 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; |
| ga.setAttribute('async', 'true'); |
| var nodes = document.documentElement.childNodes; |
| var i = -1; |
| var node; |
| do { |
| i++; |
| node = nodes[i] |
| } while(node.nodeType !== Node.ELEMENT_NODE); |
| node.appendChild(ga); |
| })(); |
| </script> |
| </div> |
| |
| |
| </footer> |
| |
| </div> |
| </div> |
| |
| </section> |
| |
| </div> |
| |
| |
| |
| <script type="text/javascript"> |
| jQuery(function () { |
| SphinxRtdTheme.Navigation.enable(true); |
| }); |
| </script> |
| |
| |
| |
| |
| |
| |
| </body> |
| </html> |
