| |
| |
| <!-- |
| Javascript to render AIRFLOW-XXX and PR references in text |
| as HTML links. |
| |
| Overrides extrahead block from sphinx_rtd_theme |
| https://www.sphinx-doc.org/en/master/templating.html |
| --> |
| |
| |
| <!DOCTYPE html> |
| <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> |
| <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> |
| <head> |
| <meta charset="utf-8"> |
| |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| |
| <title>airflow.hooks.postgres_hook — Airflow Documentation</title> |
| |
| |
| |
| |
| <link rel="shortcut icon" href="../../../_static/pin_32.png"/> |
| |
| |
| |
| |
| |
| <script type="text/javascript" src="../../../_static/js/modernizr.min.js"></script> |
| |
| |
| <script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script> |
| <script type="text/javascript" src="../../../_static/jquery.js"></script> |
| <script type="text/javascript" src="../../../_static/underscore.js"></script> |
| <script type="text/javascript" src="../../../_static/doctools.js"></script> |
| <script type="text/javascript" src="../../../_static/language_data.js"></script> |
| <script type="text/javascript" src="../../../_static/jira-links.js"></script> |
| |
| <script type="text/javascript" src="../../../_static/js/theme.js"></script> |
| |
| |
| |
| |
| <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" /> |
| <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" /> |
| <link rel="stylesheet" href="../../../_static/graphviz.css" type="text/css" /> |
| <link rel="stylesheet" href="../../../_static/exampleinclude.css" type="text/css" /> |
| <link rel="index" title="Index" href="../../../genindex.html" /> |
| <link rel="search" title="Search" href="../../../search.html" /> |
| |
| <script> |
| </script> |
| <style> |
| |
| </style> |
| |
| </head> |
| |
| <body class="wy-body-for-nav"> |
| |
| |
| <div class="wy-grid-for-nav"> |
| |
| <nav data-toggle="wy-nav-shift" class="wy-nav-side"> |
| <div class="wy-side-scroll"> |
| <div class="wy-side-nav-search" > |
| |
| |
| |
| <a href="../../../index.html" class="icon icon-home"> Airflow |
| |
| |
| |
| </a> |
| |
| |
| |
| |
| <div class="version"> |
| 1.10.8 |
| </div> |
| |
| |
| |
| |
| <div role="search"> |
| <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get"> |
| <input type="text" name="q" placeholder="Search docs" /> |
| <input type="hidden" name="check_keywords" value="yes" /> |
| <input type="hidden" name="area" value="default" /> |
| </form> |
| </div> |
| |
| |
| </div> |
| |
| <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> |
| |
| |
| |
| |
| |
| |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="../../../project.html">Project</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../license.html">License</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../start.html">Quick Start</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../installation.html">Installation</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../tutorial.html">Tutorial</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../howto/index.html">How-to Guides</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../ui.html">UI / Screenshots</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../concepts.html">Concepts</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../profiling.html">Data Profiling</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../cli.html">Command Line Interface Reference</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../scheduler.html">Scheduling & Triggers</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../executor/index.html">Executor</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../plugins.html">Plugins</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../security.html">Security</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../timezone.html">Time zones</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../api.html">REST API Reference</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../integration.html">Integration</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../metrics.html">Metrics</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../errors.html">Error Tracking</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../kubernetes.html">Kubernetes</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../lineage.html">Lineage</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../dag-serialization.html">DAG Serialization</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../changelog.html">Changelog</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../best-practices.html">Best Practices</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../faq.html">FAQ</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../macros.html">Macros reference</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../privacy_notice.html">Privacy Notice</a></li> |
| </ul> |
| <p class="caption"><span class="caption-text">References</span></p> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="../../../_api/index.html">Python API</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../configurations-ref.html">Configurations</a></li> |
| </ul> |
| |
| |
| |
| </div> |
| </div> |
| </nav> |
| |
| <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> |
| |
| |
| <nav class="wy-nav-top" aria-label="top navigation"> |
| |
| <i data-toggle="wy-nav-top" class="fa fa-bars"></i> |
| <a href="../../../index.html">Airflow</a> |
| |
| </nav> |
| |
| |
| <div class="wy-nav-content"> |
| |
| <div class="rst-content"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div role="navigation" aria-label="breadcrumbs navigation"> |
| |
| <ul class="wy-breadcrumbs"> |
| |
| <li><a href="../../../index.html">Docs</a> »</li> |
| |
| <li><a href="../../index.html">Module code</a> »</li> |
| |
| <li><a href="../hooks.html">airflow.hooks</a> »</li> |
| |
| <li>airflow.hooks.postgres_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.postgres_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">os</span> |
| <span class="kn">import</span> <span class="nn">psycopg2</span> |
| <span class="kn">import</span> <span class="nn">psycopg2.extensions</span> |
| <span class="kn">import</span> <span class="nn">psycopg2.extras</span> |
| <span class="kn">from</span> <span class="nn">contextlib</span> <span class="kn">import</span> <span class="n">closing</span> |
| |
| <span class="kn">from</span> <span class="nn">airflow.hooks.dbapi_hook</span> <span class="kn">import</span> <span class="n">DbApiHook</span> |
| |
| |
| <div class="viewcode-block" id="PostgresHook"><a class="viewcode-back" href="../../../_api/airflow/hooks/postgres_hook/index.html#airflow.hooks.postgres_hook.PostgresHook">[docs]</a><span class="k">class</span> <span class="nc">PostgresHook</span><span class="p">(</span><span class="n">DbApiHook</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Interact with Postgres.</span> |
| |
| <span class="sd"> You can specify ssl parameters in the extra field of your connection</span> |
| <span class="sd"> as ``{"sslmode": "require", "sslcert": "/path/to/cert.pem", etc}``.</span> |
| <span class="sd"> Also you can choose cursor as ``{"cursor": "dictcursor"}``. Refer to the</span> |
| <span class="sd"> psycopg2.extras for more details.</span> |
| |
| <span class="sd"> Note: For Redshift, use keepalives_idle in the extra connection parameters</span> |
| <span class="sd"> and set it to less than 300 seconds.</span> |
| |
| <span class="sd"> Note: For AWS IAM authentication, use iam in the extra connection parameters</span> |
| <span class="sd"> and set it to true. Leave the password field empty. This will use the</span> |
| <span class="sd"> "aws_default" connection to get the temporary token unless you override</span> |
| <span class="sd"> in extras.</span> |
| <span class="sd"> extras example: ``{"iam":true, "aws_conn_id":"my_aws_conn"}``</span> |
| <span class="sd"> For Redshift, also use redshift in the extra connection parameters and</span> |
| <span class="sd"> set it to true. The cluster-identifier is extracted from the beginning of</span> |
| <span class="sd"> the host field, so is optional. It can however be overridden in the extra field.</span> |
| <span class="sd"> extras example: ``{"iam":true, "redshift":true, "cluster-identifier": "my_cluster_id"}``</span> |
| <span class="sd"> """</span> |
| <div class="viewcode-block" id="PostgresHook.conn_name_attr"><a class="viewcode-back" href="../../../_api/airflow/hooks/postgres_hook/index.html#airflow.hooks.postgres_hook.PostgresHook.conn_name_attr">[docs]</a> <span class="n">conn_name_attr</span> <span class="o">=</span> <span class="s1">'postgres_conn_id'</span></div> |
| <div class="viewcode-block" id="PostgresHook.default_conn_name"><a class="viewcode-back" href="../../../_api/airflow/hooks/postgres_hook/index.html#airflow.hooks.postgres_hook.PostgresHook.default_conn_name">[docs]</a> <span class="n">default_conn_name</span> <span class="o">=</span> <span class="s1">'postgres_default'</span></div> |
| <div class="viewcode-block" id="PostgresHook.supports_autocommit"><a class="viewcode-back" href="../../../_api/airflow/hooks/postgres_hook/index.html#airflow.hooks.postgres_hook.PostgresHook.supports_autocommit">[docs]</a> <span class="n">supports_autocommit</span> <span class="o">=</span> <span class="kc">True</span></div> |
| |
| <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</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="nb">super</span><span class="p">(</span><span class="n">PostgresHook</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="PostgresHook._get_cursor"><a class="viewcode-back" href="../../../_api/airflow/hooks/postgres_hook/index.html#airflow.hooks.postgres_hook.PostgresHook._get_cursor">[docs]</a> <span class="k">def</span> <span class="nf">_get_cursor</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">raw_cursor</span><span class="p">):</span> |
| <span class="n">_cursor</span> <span class="o">=</span> <span class="n">raw_cursor</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> |
| <span class="k">if</span> <span class="n">_cursor</span> <span class="o">==</span> <span class="s1">'dictcursor'</span><span class="p">:</span> |
| <span class="k">return</span> <span class="n">psycopg2</span><span class="o">.</span><span class="n">extras</span><span class="o">.</span><span class="n">DictCursor</span> |
| <span class="k">if</span> <span class="n">_cursor</span> <span class="o">==</span> <span class="s1">'realdictcursor'</span><span class="p">:</span> |
| <span class="k">return</span> <span class="n">psycopg2</span><span class="o">.</span><span class="n">extras</span><span class="o">.</span><span class="n">RealDictCursor</span> |
| <span class="k">if</span> <span class="n">_cursor</span> <span class="o">==</span> <span class="s1">'namedtuplecursor'</span><span class="p">:</span> |
| <span class="k">return</span> <span class="n">psycopg2</span><span class="o">.</span><span class="n">extras</span><span class="o">.</span><span class="n">NamedTupleCursor</span> |
| <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'Invalid cursor passed </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">_cursor</span><span class="p">))</span></div> |
| |
| <div class="viewcode-block" id="PostgresHook.get_conn"><a class="viewcode-back" href="../../../_api/airflow/hooks/postgres_hook/index.html#airflow.hooks.postgres_hook.PostgresHook.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_id</span> <span class="o">=</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">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="n">conn_id</span><span class="p">)</span> |
| |
| <span class="c1"># check for authentication via AWS IAM</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">'iam'</span><span class="p">,</span> <span class="kc">False</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="n">conn</span><span class="o">.</span><span class="n">port</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_iam_token</span><span class="p">(</span><span class="n">conn</span><span class="p">)</span> |
| |
| <span class="n">conn_args</span> <span class="o">=</span> <span class="nb">dict</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="p">,</span> |
| <span class="n">user</span><span class="o">=</span><span class="n">conn</span><span class="o">.</span><span class="n">login</span><span class="p">,</span> |
| <span class="n">password</span><span class="o">=</span><span class="n">conn</span><span class="o">.</span><span class="n">password</span><span class="p">,</span> |
| <span class="n">dbname</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">schema</span> <span class="ow">or</span> <span class="n">conn</span><span class="o">.</span><span class="n">schema</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="p">)</span> |
| <span class="n">raw_cursor</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">'cursor'</span><span class="p">,</span> <span class="kc">False</span><span class="p">)</span> |
| <span class="k">if</span> <span class="n">raw_cursor</span><span class="p">:</span> |
| <span class="n">conn_args</span><span class="p">[</span><span class="s1">'cursor_factory'</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_cursor</span><span class="p">(</span><span class="n">raw_cursor</span><span class="p">)</span> |
| <span class="c1"># check for ssl parameters in conn.extra</span> |
| <span class="k">for</span> <span class="n">arg_name</span><span class="p">,</span> <span class="n">arg_val</span> <span class="ow">in</span> <span class="n">conn</span><span class="o">.</span><span class="n">extra_dejson</span><span class="o">.</span><span class="n">items</span><span class="p">():</span> |
| <span class="k">if</span> <span class="n">arg_name</span> <span class="ow">in</span> <span class="p">[</span><span class="s1">'sslmode'</span><span class="p">,</span> <span class="s1">'sslcert'</span><span class="p">,</span> <span class="s1">'sslkey'</span><span class="p">,</span> |
| <span class="s1">'sslrootcert'</span><span class="p">,</span> <span class="s1">'sslcrl'</span><span class="p">,</span> <span class="s1">'application_name'</span><span class="p">,</span> |
| <span class="s1">'keepalives_idle'</span><span class="p">]:</span> |
| <span class="n">conn_args</span><span class="p">[</span><span class="n">arg_name</span><span class="p">]</span> <span class="o">=</span> <span class="n">arg_val</span> |
| |
| <span class="bp">self</span><span class="o">.</span><span class="n">conn</span> <span class="o">=</span> <span class="n">psycopg2</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="o">**</span><span class="n">conn_args</span><span class="p">)</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">conn</span></div> |
| |
| <div class="viewcode-block" id="PostgresHook.copy_expert"><a class="viewcode-back" href="../../../_api/airflow/hooks/postgres_hook/index.html#airflow.hooks.postgres_hook.PostgresHook.copy_expert">[docs]</a> <span class="k">def</span> <span class="nf">copy_expert</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">sql</span><span class="p">,</span> <span class="n">filename</span><span class="p">,</span> <span class="nb">open</span><span class="o">=</span><span class="nb">open</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Executes SQL using psycopg2 copy_expert method.</span> |
| <span class="sd"> Necessary to execute COPY command without access to a superuser.</span> |
| |
| <span class="sd"> Note: if this method is called with a "COPY FROM" statement and</span> |
| <span class="sd"> the specified input file does not exist, it creates an empty</span> |
| <span class="sd"> file and no data is loaded, but the operation succeeds.</span> |
| <span class="sd"> So if users want to be aware when the input file does not exist,</span> |
| <span class="sd"> they have to check its existence by themselves.</span> |
| <span class="sd"> """</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isfile</span><span class="p">(</span><span class="n">filename</span><span class="p">):</span> |
| <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">filename</span><span class="p">,</span> <span class="s1">'w'</span><span class="p">):</span> |
| <span class="k">pass</span> |
| |
| <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">filename</span><span class="p">,</span> <span class="s1">'r+'</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span> |
| <span class="k">with</span> <span class="n">closing</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">get_conn</span><span class="p">())</span> <span class="k">as</span> <span class="n">conn</span><span class="p">:</span> |
| <span class="k">with</span> <span class="n">closing</span><span class="p">(</span><span class="n">conn</span><span class="o">.</span><span class="n">cursor</span><span class="p">())</span> <span class="k">as</span> <span class="n">cur</span><span class="p">:</span> |
| <span class="n">cur</span><span class="o">.</span><span class="n">copy_expert</span><span class="p">(</span><span class="n">sql</span><span class="p">,</span> <span class="n">f</span><span class="p">)</span> |
| <span class="n">f</span><span class="o">.</span><span class="n">truncate</span><span class="p">(</span><span class="n">f</span><span class="o">.</span><span class="n">tell</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="PostgresHook.bulk_load"><a class="viewcode-back" href="../../../_api/airflow/hooks/postgres_hook/index.html#airflow.hooks.postgres_hook.PostgresHook.bulk_load">[docs]</a> <span class="k">def</span> <span class="nf">bulk_load</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"> Loads a tab-delimited file into a database table</span> |
| <span class="sd"> """</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">copy_expert</span><span class="p">(</span><span class="s2">"COPY </span><span class="si">{table}</span><span class="s2"> FROM STDIN"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">table</span><span class="o">=</span><span class="n">table</span><span class="p">),</span> <span class="n">tmp_file</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="PostgresHook.bulk_dump"><a class="viewcode-back" href="../../../_api/airflow/hooks/postgres_hook/index.html#airflow.hooks.postgres_hook.PostgresHook.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="bp">self</span><span class="o">.</span><span class="n">copy_expert</span><span class="p">(</span><span class="s2">"COPY </span><span class="si">{table}</span><span class="s2"> TO STDOUT"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">table</span><span class="o">=</span><span class="n">table</span><span class="p">),</span> <span class="n">tmp_file</span><span class="p">)</span></div> |
| |
| <span class="nd">@staticmethod</span> |
| <div class="viewcode-block" id="PostgresHook._serialize_cell"><a class="viewcode-back" href="../../../_api/airflow/hooks/postgres_hook/index.html#airflow.hooks.postgres_hook.PostgresHook._serialize_cell">[docs]</a> <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"> Postgresql will adapt all arguments to the execute() method internally,</span> |
| <span class="sd"> hence we return cell without any conversion.</span> |
| |
| <span class="sd"> See http://initd.org/psycopg/docs/advanced.html#adapting-new-types for</span> |
| <span class="sd"> more information.</span> |
| |
| <span class="sd"> :param cell: The cell to insert into the table</span> |
| <span class="sd"> :type cell: object</span> |
| <span class="sd"> :param conn: The database connection</span> |
| <span class="sd"> :type conn: connection object</span> |
| <span class="sd"> :return: The cell</span> |
| <span class="sd"> :rtype: object</span> |
| <span class="sd"> """</span> |
| <span class="k">return</span> <span class="n">cell</span></div> |
| |
| <div class="viewcode-block" id="PostgresHook.get_iam_token"><a class="viewcode-back" href="../../../_api/airflow/hooks/postgres_hook/index.html#airflow.hooks.postgres_hook.PostgresHook.get_iam_token">[docs]</a> <span class="k">def</span> <span class="nf">get_iam_token</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"> Uses AWSHook to retrieve a temporary password to connect to Postgres</span> |
| <span class="sd"> or Redshift. Port is required. If none is provided, default is used for</span> |
| <span class="sd"> each service</span> |
| <span class="sd"> """</span> |
| <span class="kn">from</span> <span class="nn">airflow.contrib.hooks.aws_hook</span> <span class="kn">import</span> <span class="n">AwsHook</span> |
| |
| <span class="n">redshift</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">'redshift'</span><span class="p">,</span> <span class="kc">False</span><span class="p">)</span> |
| <span class="n">aws_conn_id</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">'aws_conn_id'</span><span class="p">,</span> <span class="s1">'aws_default'</span><span class="p">)</span> |
| <span class="n">aws_hook</span> <span class="o">=</span> <span class="n">AwsHook</span><span class="p">(</span><span class="n">aws_conn_id</span><span class="p">)</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="k">if</span> <span class="n">conn</span><span class="o">.</span><span class="n">port</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="n">port</span> <span class="o">=</span> <span class="mi">5439</span> <span class="k">if</span> <span class="n">redshift</span> <span class="k">else</span> <span class="mi">5432</span> |
| <span class="k">else</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">redshift</span><span class="p">:</span> |
| <span class="c1"># Pull the custer-identifier from the beginning of the Redshift URL</span> |
| <span class="c1"># ex. my-cluster.ccdre4hpd39h.us-east-1.redshift.amazonaws.com returns my-cluster</span> |
| <span class="n">cluster_identifier</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">'cluster-identifier'</span><span class="p">,</span> <span class="n">conn</span><span class="o">.</span><span class="n">host</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">'.'</span><span class="p">)[</span><span class="mi">0</span><span class="p">])</span> |
| <span class="n">client</span> <span class="o">=</span> <span class="n">aws_hook</span><span class="o">.</span><span class="n">get_client_type</span><span class="p">(</span><span class="s1">'redshift'</span><span class="p">)</span> |
| <span class="n">cluster_creds</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">get_cluster_credentials</span><span class="p">(</span> |
| <span class="n">DbUser</span><span class="o">=</span><span class="n">conn</span><span class="o">.</span><span class="n">login</span><span class="p">,</span> |
| <span class="n">DbName</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">schema</span> <span class="ow">or</span> <span class="n">conn</span><span class="o">.</span><span class="n">schema</span><span class="p">,</span> |
| <span class="n">ClusterIdentifier</span><span class="o">=</span><span class="n">cluster_identifier</span><span class="p">,</span> |
| <span class="n">AutoCreate</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span> |
| <span class="n">token</span> <span class="o">=</span> <span class="n">cluster_creds</span><span class="p">[</span><span class="s1">'DbPassword'</span><span class="p">]</span> |
| <span class="n">login</span> <span class="o">=</span> <span class="n">cluster_creds</span><span class="p">[</span><span class="s1">'DbUser'</span><span class="p">]</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="n">client</span> <span class="o">=</span> <span class="n">aws_hook</span><span class="o">.</span><span class="n">get_client_type</span><span class="p">(</span><span class="s1">'rds'</span><span class="p">)</span> |
| <span class="n">token</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">generate_db_auth_token</span><span class="p">(</span><span class="n">conn</span><span class="o">.</span><span class="n">host</span><span class="p">,</span> <span class="n">port</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="k">return</span> <span class="n">login</span><span class="p">,</span> <span class="n">token</span><span class="p">,</span> <span class="n">port</span></div></div> |
| </pre></div> |
| |
| </div> |
| |
| </div> |
| |
| |
| <footer> |
| |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p> |
| |
| </p> |
| </div> |
| Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. |
| <div class="footer">This page uses <a href="https://analytics.google.com/"> |
| Google Analytics</a> to collect statistics. You can disable it by blocking |
| the JavaScript coming from www.google-analytics.com. Check our |
| <a href="../../../privacy_notice.html">Privacy Policy</a> |
| for more details. |
| </div> |
| |
| |
| </footer> |
| |
| </div> |
| </div> |
| |
| </section> |
| |
| </div> |
| |
| |
| |
| <script type="text/javascript"> |
| jQuery(function () { |
| SphinxRtdTheme.Navigation.enable(true); |
| }); |
| </script> |
| |
| |
| |
| |
| <!-- Theme Analytics --> |
| <script> |
| (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ |
| (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), |
| m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) |
| })(window,document,'script','https://www.google-analytics.com/analytics.js','ga'); |
| |
| ga('create', 'UA-140539454-1', 'auto'); |
| ga('send', 'pageview'); |
| </script> |
| |
| |
| |
| |
| </body> |
| </html> |