| |
| |
| <!-- |
| 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.contrib.hooks.gcp_sql_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/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="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.6 |
| </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="../../../../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="../../../../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> |
| <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> |
| </ul> |
| |
| |
| |
| </div> |
| </div> |
| </nav> |
| |
| <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> |
| |
| |
| <nav class="wy-nav-top" aria-label="top navigation"> |
| |
| <i data-toggle="wy-nav-top" class="fa fa-bars"></i> |
| <a href="../../../../index.html">Airflow</a> |
| |
| </nav> |
| |
| |
| <div class="wy-nav-content"> |
| |
| <div class="rst-content"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div role="navigation" aria-label="breadcrumbs navigation"> |
| |
| <ul class="wy-breadcrumbs"> |
| |
| <li><a href="../../../../index.html">Docs</a> »</li> |
| |
| <li><a href="../../../index.html">Module code</a> »</li> |
| |
| <li><a href="../hooks.html">airflow.contrib.hooks</a> »</li> |
| |
| <li>airflow.contrib.hooks.gcp_sql_hook</li> |
| |
| |
| <li class="wy-breadcrumbs-aside"> |
| |
| </li> |
| |
| </ul> |
| |
| |
| <hr/> |
| </div> |
| <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |
| <div itemprop="articleBody"> |
| |
| <h1>Source code for airflow.contrib.hooks.gcp_sql_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">errno</span> |
| <span class="kn">import</span> <span class="nn">json</span> |
| <span class="kn">import</span> <span class="nn">os</span> |
| <span class="kn">import</span> <span class="nn">random</span> |
| <span class="kn">import</span> <span class="nn">re</span> |
| <span class="kn">import</span> <span class="nn">shutil</span> |
| <span class="kn">import</span> <span class="nn">string</span> |
| |
| <span class="kn">import</span> <span class="nn">socket</span> |
| <span class="kn">import</span> <span class="nn">platform</span> |
| <span class="kn">import</span> <span class="nn">subprocess</span> |
| <span class="kn">import</span> <span class="nn">time</span> |
| <span class="kn">import</span> <span class="nn">uuid</span> |
| <span class="kn">import</span> <span class="nn">os.path</span> |
| |
| <span class="kn">from</span> <span class="nn">googleapiclient.errors</span> <span class="k">import</span> <span class="n">HttpError</span> |
| <span class="kn">from</span> <span class="nn">subprocess</span> <span class="k">import</span> <span class="n">Popen</span><span class="p">,</span> <span class="n">PIPE</span> |
| <span class="kn">from</span> <span class="nn">six.moves.urllib.parse</span> <span class="k">import</span> <span class="n">quote_plus</span> |
| |
| <span class="kn">import</span> <span class="nn">requests</span> |
| <span class="kn">from</span> <span class="nn">googleapiclient.discovery</span> <span class="k">import</span> <span class="n">build</span> |
| |
| <span class="kn">from</span> <span class="nn">airflow</span> <span class="k">import</span> <span class="n">AirflowException</span><span class="p">,</span> <span class="n">LoggingMixin</span> |
| <span class="kn">from</span> <span class="nn">airflow.contrib.hooks.gcp_api_base_hook</span> <span class="k">import</span> <span class="n">GoogleCloudBaseHook</span> |
| |
| <span class="c1"># Number of retries - used by googleapiclient method calls to perform retries</span> |
| <span class="c1"># For requests that are "retriable"</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.hooks.mysql_hook</span> <span class="k">import</span> <span class="n">MySqlHook</span> |
| <span class="kn">from</span> <span class="nn">airflow.hooks.postgres_hook</span> <span class="k">import</span> <span class="n">PostgresHook</span> |
| <span class="kn">from</span> <span class="nn">airflow.models</span> <span class="k">import</span> <span class="n">Connection</span> |
| <span class="kn">from</span> <span class="nn">airflow.utils.db</span> <span class="k">import</span> <span class="n">provide_session</span> |
| |
| <div class="viewcode-block" id="UNIX_PATH_MAX"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_sql_hook/index.html#airflow.contrib.hooks.gcp_sql_hook.UNIX_PATH_MAX">[docs]</a><span class="n">UNIX_PATH_MAX</span> <span class="o">=</span> <span class="mi">108</span></div> |
| |
| <span class="c1"># Time to sleep between active checks of the operation results</span> |
| <div class="viewcode-block" id="TIME_TO_SLEEP_IN_SECONDS"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_sql_hook/index.html#airflow.contrib.hooks.gcp_sql_hook.TIME_TO_SLEEP_IN_SECONDS">[docs]</a><span class="n">TIME_TO_SLEEP_IN_SECONDS</span> <span class="o">=</span> <span class="mi">1</span></div> |
| |
| |
| <div class="viewcode-block" id="CloudSqlOperationStatus"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_sql_hook/index.html#airflow.contrib.hooks.gcp_sql_hook.CloudSqlOperationStatus">[docs]</a><span class="k">class</span> <span class="nc">CloudSqlOperationStatus</span><span class="p">:</span> |
| <div class="viewcode-block" id="CloudSqlOperationStatus.PENDING"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_sql_hook/index.html#airflow.contrib.hooks.gcp_sql_hook.CloudSqlOperationStatus.PENDING">[docs]</a> <span class="n">PENDING</span> <span class="o">=</span> <span class="s2">"PENDING"</span></div> |
| <div class="viewcode-block" id="CloudSqlOperationStatus.RUNNING"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_sql_hook/index.html#airflow.contrib.hooks.gcp_sql_hook.CloudSqlOperationStatus.RUNNING">[docs]</a> <span class="n">RUNNING</span> <span class="o">=</span> <span class="s2">"RUNNING"</span></div> |
| <div class="viewcode-block" id="CloudSqlOperationStatus.DONE"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_sql_hook/index.html#airflow.contrib.hooks.gcp_sql_hook.CloudSqlOperationStatus.DONE">[docs]</a> <span class="n">DONE</span> <span class="o">=</span> <span class="s2">"DONE"</span></div> |
| <div class="viewcode-block" id="CloudSqlOperationStatus.UNKNOWN"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_sql_hook/index.html#airflow.contrib.hooks.gcp_sql_hook.CloudSqlOperationStatus.UNKNOWN">[docs]</a> <span class="n">UNKNOWN</span> <span class="o">=</span> <span class="s2">"UNKNOWN"</span></div></div> |
| |
| |
| <span class="c1"># noinspection PyAbstractClass</span> |
| <div class="viewcode-block" id="CloudSqlHook"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_sql_hook/index.html#airflow.contrib.hooks.gcp_sql_hook.CloudSqlHook">[docs]</a><span class="k">class</span> <span class="nc">CloudSqlHook</span><span class="p">(</span><span class="n">GoogleCloudBaseHook</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Hook for Google Cloud SQL APIs.</span> |
| |
| <span class="sd"> All the methods in the hook where project_id is used must be called with</span> |
| <span class="sd"> keyword arguments rather than positional.</span> |
| <span class="sd"> """</span> |
| <div class="viewcode-block" id="CloudSqlHook._conn"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_sql_hook/index.html#airflow.contrib.hooks.gcp_sql_hook.CloudSqlHook._conn">[docs]</a> <span class="n">_conn</span> <span class="o">=</span> <span class="kc">None</span></div> |
| |
| <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">api_version</span><span class="p">,</span> |
| <span class="n">gcp_conn_id</span><span class="o">=</span><span class="s1">'google_cloud_default'</span><span class="p">,</span> |
| <span class="n">delegate_to</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="nb">super</span><span class="p">(</span><span class="n">CloudSqlHook</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="n">gcp_conn_id</span><span class="p">,</span> <span class="n">delegate_to</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">api_version</span> <span class="o">=</span> <span class="n">api_version</span> |
| |
| <div class="viewcode-block" id="CloudSqlHook.get_conn"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_sql_hook/index.html#airflow.contrib.hooks.gcp_sql_hook.CloudSqlHook.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"> Retrieves connection to Cloud SQL.</span> |
| |
| <span class="sd"> :return: Google Cloud SQL services object.</span> |
| <span class="sd"> :rtype: dict</span> |
| <span class="sd"> """</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_conn</span><span class="p">:</span> |
| <span class="n">http_authorized</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_authorize</span><span class="p">()</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_conn</span> <span class="o">=</span> <span class="n">build</span><span class="p">(</span><span class="s1">'sqladmin'</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">api_version</span><span class="p">,</span> |
| <span class="n">http</span><span class="o">=</span><span class="n">http_authorized</span><span class="p">,</span> <span class="n">cache_discovery</span><span class="o">=</span><span class="kc">False</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> |
| |
| <span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">fallback_to_default_project_id</span> |
| <div class="viewcode-block" id="CloudSqlHook.get_instance"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_sql_hook/index.html#airflow.contrib.hooks.gcp_sql_hook.CloudSqlHook.get_instance">[docs]</a> <span class="k">def</span> <span class="nf">get_instance</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">instance</span><span class="p">,</span> <span class="n">project_id</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Retrieves a resource containing information about a Cloud SQL instance.</span> |
| |
| <span class="sd"> :param instance: Database instance ID. This does not include the project ID.</span> |
| <span class="sd"> :type instance: str</span> |
| <span class="sd"> :param project_id: Project ID of the project that contains the instance. If set</span> |
| <span class="sd"> to None or missing, the default project_id from the GCP connection is used.</span> |
| <span class="sd"> :type project_id: str</span> |
| <span class="sd"> :return: A Cloud SQL instance resource.</span> |
| <span class="sd"> :rtype: dict</span> |
| <span class="sd"> """</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span><span class="o">.</span><span class="n">instances</span><span class="p">()</span><span class="o">.</span><span class="n">get</span><span class="p">(</span> |
| <span class="n">project</span><span class="o">=</span><span class="n">project_id</span><span class="p">,</span> |
| <span class="n">instance</span><span class="o">=</span><span class="n">instance</span> |
| <span class="p">)</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">num_retries</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">num_retries</span><span class="p">)</span></div> |
| |
| <span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">fallback_to_default_project_id</span> |
| <div class="viewcode-block" id="CloudSqlHook.create_instance"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_sql_hook/index.html#airflow.contrib.hooks.gcp_sql_hook.CloudSqlHook.create_instance">[docs]</a> <span class="k">def</span> <span class="nf">create_instance</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">body</span><span class="p">,</span> <span class="n">project_id</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Creates a new Cloud SQL instance.</span> |
| |
| <span class="sd"> :param body: Body required by the Cloud SQL insert API, as described in</span> |
| <span class="sd"> https://cloud.google.com/sql/docs/mysql/admin-api/v1beta4/instances/insert#request-body.</span> |
| <span class="sd"> :type body: dict</span> |
| <span class="sd"> :param project_id: Project ID of the project that contains the instance. If set</span> |
| <span class="sd"> to None or missing, the default project_id from the GCP connection is used.</span> |
| <span class="sd"> :type project_id: str</span> |
| <span class="sd"> :return: None</span> |
| <span class="sd"> """</span> |
| <span class="n">response</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="o">.</span><span class="n">instances</span><span class="p">()</span><span class="o">.</span><span class="n">insert</span><span class="p">(</span> |
| <span class="n">project</span><span class="o">=</span><span class="n">project_id</span><span class="p">,</span> |
| <span class="n">body</span><span class="o">=</span><span class="n">body</span> |
| <span class="p">)</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">num_retries</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">num_retries</span><span class="p">)</span> |
| <span class="n">operation_name</span> <span class="o">=</span> <span class="n">response</span><span class="p">[</span><span class="s2">"name"</span><span class="p">]</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_wait_for_operation_to_complete</span><span class="p">(</span><span class="n">project_id</span><span class="o">=</span><span class="n">project_id</span><span class="p">,</span> |
| <span class="n">operation_name</span><span class="o">=</span><span class="n">operation_name</span><span class="p">)</span></div> |
| |
| <span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">fallback_to_default_project_id</span> |
| <div class="viewcode-block" id="CloudSqlHook.patch_instance"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_sql_hook/index.html#airflow.contrib.hooks.gcp_sql_hook.CloudSqlHook.patch_instance">[docs]</a> <span class="k">def</span> <span class="nf">patch_instance</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">body</span><span class="p">,</span> <span class="n">instance</span><span class="p">,</span> <span class="n">project_id</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Updates settings of a Cloud SQL instance.</span> |
| |
| <span class="sd"> Caution: This is not a partial update, so you must include values for</span> |
| <span class="sd"> all the settings that you want to retain.</span> |
| |
| <span class="sd"> :param body: Body required by the Cloud SQL patch API, as described in</span> |
| <span class="sd"> https://cloud.google.com/sql/docs/mysql/admin-api/v1beta4/instances/patch#request-body.</span> |
| <span class="sd"> :type body: dict</span> |
| <span class="sd"> :param instance: Cloud SQL instance ID. This does not include the project ID.</span> |
| <span class="sd"> :type instance: str</span> |
| <span class="sd"> :param project_id: Project ID of the project that contains the instance. If set</span> |
| <span class="sd"> to None or missing, the default project_id from the GCP connection is used.</span> |
| <span class="sd"> :type project_id: str</span> |
| <span class="sd"> :return: None</span> |
| <span class="sd"> """</span> |
| <span class="n">response</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="o">.</span><span class="n">instances</span><span class="p">()</span><span class="o">.</span><span class="n">patch</span><span class="p">(</span> |
| <span class="n">project</span><span class="o">=</span><span class="n">project_id</span><span class="p">,</span> |
| <span class="n">instance</span><span class="o">=</span><span class="n">instance</span><span class="p">,</span> |
| <span class="n">body</span><span class="o">=</span><span class="n">body</span> |
| <span class="p">)</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">num_retries</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">num_retries</span><span class="p">)</span> |
| <span class="n">operation_name</span> <span class="o">=</span> <span class="n">response</span><span class="p">[</span><span class="s2">"name"</span><span class="p">]</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_wait_for_operation_to_complete</span><span class="p">(</span><span class="n">project_id</span><span class="o">=</span><span class="n">project_id</span><span class="p">,</span> |
| <span class="n">operation_name</span><span class="o">=</span><span class="n">operation_name</span><span class="p">)</span></div> |
| |
| <span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">fallback_to_default_project_id</span> |
| <div class="viewcode-block" id="CloudSqlHook.delete_instance"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_sql_hook/index.html#airflow.contrib.hooks.gcp_sql_hook.CloudSqlHook.delete_instance">[docs]</a> <span class="k">def</span> <span class="nf">delete_instance</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">instance</span><span class="p">,</span> <span class="n">project_id</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Deletes a Cloud SQL instance.</span> |
| |
| <span class="sd"> :param project_id: Project ID of the project that contains the instance. If set</span> |
| <span class="sd"> to None or missing, the default project_id from the GCP connection is used.</span> |
| <span class="sd"> :type project_id: str</span> |
| <span class="sd"> :param instance: Cloud SQL instance ID. This does not include the project ID.</span> |
| <span class="sd"> :type instance: str</span> |
| <span class="sd"> :return: None</span> |
| <span class="sd"> """</span> |
| <span class="n">response</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="o">.</span><span class="n">instances</span><span class="p">()</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span> |
| <span class="n">project</span><span class="o">=</span><span class="n">project_id</span><span class="p">,</span> |
| <span class="n">instance</span><span class="o">=</span><span class="n">instance</span><span class="p">,</span> |
| <span class="p">)</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">num_retries</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">num_retries</span><span class="p">)</span> |
| <span class="n">operation_name</span> <span class="o">=</span> <span class="n">response</span><span class="p">[</span><span class="s2">"name"</span><span class="p">]</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_wait_for_operation_to_complete</span><span class="p">(</span><span class="n">project_id</span><span class="o">=</span><span class="n">project_id</span><span class="p">,</span> |
| <span class="n">operation_name</span><span class="o">=</span><span class="n">operation_name</span><span class="p">)</span></div> |
| |
| <span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">fallback_to_default_project_id</span> |
| <div class="viewcode-block" id="CloudSqlHook.get_database"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_sql_hook/index.html#airflow.contrib.hooks.gcp_sql_hook.CloudSqlHook.get_database">[docs]</a> <span class="k">def</span> <span class="nf">get_database</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">instance</span><span class="p">,</span> <span class="n">database</span><span class="p">,</span> <span class="n">project_id</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Retrieves a database resource from a Cloud SQL instance.</span> |
| |
| <span class="sd"> :param instance: Database instance ID. This does not include the project ID.</span> |
| <span class="sd"> :type instance: str</span> |
| <span class="sd"> :param database: Name of the database in the instance.</span> |
| <span class="sd"> :type database: str</span> |
| <span class="sd"> :param project_id: Project ID of the project that contains the instance. If set</span> |
| <span class="sd"> to None or missing, the default project_id from the GCP connection is used.</span> |
| <span class="sd"> :type project_id: str</span> |
| <span class="sd"> :return: A Cloud SQL database resource, as described in</span> |
| <span class="sd"> https://cloud.google.com/sql/docs/mysql/admin-api/v1beta4/databases#resource.</span> |
| <span class="sd"> :rtype: dict</span> |
| <span class="sd"> """</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span><span class="o">.</span><span class="n">databases</span><span class="p">()</span><span class="o">.</span><span class="n">get</span><span class="p">(</span> |
| <span class="n">project</span><span class="o">=</span><span class="n">project_id</span><span class="p">,</span> |
| <span class="n">instance</span><span class="o">=</span><span class="n">instance</span><span class="p">,</span> |
| <span class="n">database</span><span class="o">=</span><span class="n">database</span> |
| <span class="p">)</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">num_retries</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">num_retries</span><span class="p">)</span></div> |
| |
| <span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">fallback_to_default_project_id</span> |
| <div class="viewcode-block" id="CloudSqlHook.create_database"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_sql_hook/index.html#airflow.contrib.hooks.gcp_sql_hook.CloudSqlHook.create_database">[docs]</a> <span class="k">def</span> <span class="nf">create_database</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">instance</span><span class="p">,</span> <span class="n">body</span><span class="p">,</span> <span class="n">project_id</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Creates a new database inside a Cloud SQL instance.</span> |
| |
| <span class="sd"> :param instance: Database instance ID. This does not include the project ID.</span> |
| <span class="sd"> :type instance: str</span> |
| <span class="sd"> :param body: The request body, as described in</span> |
| <span class="sd"> https://cloud.google.com/sql/docs/mysql/admin-api/v1beta4/databases/insert#request-body.</span> |
| <span class="sd"> :type body: dict</span> |
| <span class="sd"> :param project_id: Project ID of the project that contains the instance. If set</span> |
| <span class="sd"> to None or missing, the default project_id from the GCP connection is used.</span> |
| <span class="sd"> :type project_id: str</span> |
| <span class="sd"> :return: None</span> |
| <span class="sd"> """</span> |
| <span class="n">response</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="o">.</span><span class="n">databases</span><span class="p">()</span><span class="o">.</span><span class="n">insert</span><span class="p">(</span> |
| <span class="n">project</span><span class="o">=</span><span class="n">project_id</span><span class="p">,</span> |
| <span class="n">instance</span><span class="o">=</span><span class="n">instance</span><span class="p">,</span> |
| <span class="n">body</span><span class="o">=</span><span class="n">body</span> |
| <span class="p">)</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">num_retries</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">num_retries</span><span class="p">)</span> |
| <span class="n">operation_name</span> <span class="o">=</span> <span class="n">response</span><span class="p">[</span><span class="s2">"name"</span><span class="p">]</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_wait_for_operation_to_complete</span><span class="p">(</span><span class="n">project_id</span><span class="o">=</span><span class="n">project_id</span><span class="p">,</span> |
| <span class="n">operation_name</span><span class="o">=</span><span class="n">operation_name</span><span class="p">)</span></div> |
| |
| <span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">fallback_to_default_project_id</span> |
| <div class="viewcode-block" id="CloudSqlHook.patch_database"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_sql_hook/index.html#airflow.contrib.hooks.gcp_sql_hook.CloudSqlHook.patch_database">[docs]</a> <span class="k">def</span> <span class="nf">patch_database</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">instance</span><span class="p">,</span> <span class="n">database</span><span class="p">,</span> <span class="n">body</span><span class="p">,</span> <span class="n">project_id</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Updates a database resource inside a Cloud SQL instance.</span> |
| |
| <span class="sd"> This method supports patch semantics.</span> |
| <span class="sd"> See https://cloud.google.com/sql/docs/mysql/admin-api/how-tos/performance#patch.</span> |
| |
| <span class="sd"> :param instance: Database instance ID. This does not include the project ID.</span> |
| <span class="sd"> :type instance: str</span> |
| <span class="sd"> :param database: Name of the database to be updated in the instance.</span> |
| <span class="sd"> :type database: str</span> |
| <span class="sd"> :param body: The request body, as described in</span> |
| <span class="sd"> https://cloud.google.com/sql/docs/mysql/admin-api/v1beta4/databases/insert#request-body.</span> |
| <span class="sd"> :type body: dict</span> |
| <span class="sd"> :param project_id: Project ID of the project that contains the instance. If set</span> |
| <span class="sd"> to None or missing, the default project_id from the GCP connection is used.</span> |
| <span class="sd"> :type project_id: str</span> |
| <span class="sd"> :return: None</span> |
| <span class="sd"> """</span> |
| <span class="n">response</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="o">.</span><span class="n">databases</span><span class="p">()</span><span class="o">.</span><span class="n">patch</span><span class="p">(</span> |
| <span class="n">project</span><span class="o">=</span><span class="n">project_id</span><span class="p">,</span> |
| <span class="n">instance</span><span class="o">=</span><span class="n">instance</span><span class="p">,</span> |
| <span class="n">database</span><span class="o">=</span><span class="n">database</span><span class="p">,</span> |
| <span class="n">body</span><span class="o">=</span><span class="n">body</span> |
| <span class="p">)</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">num_retries</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">num_retries</span><span class="p">)</span> |
| <span class="n">operation_name</span> <span class="o">=</span> <span class="n">response</span><span class="p">[</span><span class="s2">"name"</span><span class="p">]</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_wait_for_operation_to_complete</span><span class="p">(</span><span class="n">project_id</span><span class="o">=</span><span class="n">project_id</span><span class="p">,</span> |
| <span class="n">operation_name</span><span class="o">=</span><span class="n">operation_name</span><span class="p">)</span></div> |
| |
| <span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">fallback_to_default_project_id</span> |
| <div class="viewcode-block" id="CloudSqlHook.delete_database"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_sql_hook/index.html#airflow.contrib.hooks.gcp_sql_hook.CloudSqlHook.delete_database">[docs]</a> <span class="k">def</span> <span class="nf">delete_database</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">instance</span><span class="p">,</span> <span class="n">database</span><span class="p">,</span> <span class="n">project_id</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Deletes a database from a Cloud SQL instance.</span> |
| |
| <span class="sd"> :param instance: Database instance ID. This does not include the project ID.</span> |
| <span class="sd"> :type instance: str</span> |
| <span class="sd"> :param database: Name of the database to be deleted in the instance.</span> |
| <span class="sd"> :type database: str</span> |
| <span class="sd"> :param project_id: Project ID of the project that contains the instance. If set</span> |
| <span class="sd"> to None or missing, the default project_id from the GCP connection is used.</span> |
| <span class="sd"> :type project_id: str</span> |
| <span class="sd"> :return: None</span> |
| <span class="sd"> """</span> |
| <span class="n">response</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="o">.</span><span class="n">databases</span><span class="p">()</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span> |
| <span class="n">project</span><span class="o">=</span><span class="n">project_id</span><span class="p">,</span> |
| <span class="n">instance</span><span class="o">=</span><span class="n">instance</span><span class="p">,</span> |
| <span class="n">database</span><span class="o">=</span><span class="n">database</span> |
| <span class="p">)</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">num_retries</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">num_retries</span><span class="p">)</span> |
| <span class="n">operation_name</span> <span class="o">=</span> <span class="n">response</span><span class="p">[</span><span class="s2">"name"</span><span class="p">]</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_wait_for_operation_to_complete</span><span class="p">(</span><span class="n">project_id</span><span class="o">=</span><span class="n">project_id</span><span class="p">,</span> |
| <span class="n">operation_name</span><span class="o">=</span><span class="n">operation_name</span><span class="p">)</span></div> |
| |
| <span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">fallback_to_default_project_id</span> |
| <div class="viewcode-block" id="CloudSqlHook.export_instance"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_sql_hook/index.html#airflow.contrib.hooks.gcp_sql_hook.CloudSqlHook.export_instance">[docs]</a> <span class="k">def</span> <span class="nf">export_instance</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">instance</span><span class="p">,</span> <span class="n">body</span><span class="p">,</span> <span class="n">project_id</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Exports data from a Cloud SQL instance to a Cloud Storage bucket as a SQL dump</span> |
| <span class="sd"> or CSV file.</span> |
| |
| <span class="sd"> :param instance: Database instance ID of the Cloud SQL instance. This does not include the</span> |
| <span class="sd"> project ID.</span> |
| <span class="sd"> :type instance: str</span> |
| <span class="sd"> :param body: The request body, as described in</span> |
| <span class="sd"> https://cloud.google.com/sql/docs/mysql/admin-api/v1beta4/instances/export#request-body</span> |
| <span class="sd"> :type body: dict</span> |
| <span class="sd"> :param project_id: Project ID of the project that contains the instance. If set</span> |
| <span class="sd"> to None or missing, the default project_id from the GCP connection is used.</span> |
| <span class="sd"> :type project_id: str</span> |
| <span class="sd"> :return: None</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="bp">self</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span><span class="o">.</span><span class="n">instances</span><span class="p">()</span><span class="o">.</span><span class="n">export</span><span class="p">(</span> |
| <span class="n">project</span><span class="o">=</span><span class="n">project_id</span><span class="p">,</span> |
| <span class="n">instance</span><span class="o">=</span><span class="n">instance</span><span class="p">,</span> |
| <span class="n">body</span><span class="o">=</span><span class="n">body</span> |
| <span class="p">)</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">num_retries</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">num_retries</span><span class="p">)</span> |
| <span class="n">operation_name</span> <span class="o">=</span> <span class="n">response</span><span class="p">[</span><span class="s2">"name"</span><span class="p">]</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_wait_for_operation_to_complete</span><span class="p">(</span><span class="n">project_id</span><span class="o">=</span><span class="n">project_id</span><span class="p">,</span> |
| <span class="n">operation_name</span><span class="o">=</span><span class="n">operation_name</span><span class="p">)</span> |
| <span class="k">except</span> <span class="n">HttpError</span> <span class="k">as</span> <span class="n">ex</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span> |
| <span class="s1">'Exporting instance </span><span class="si">{}</span><span class="s1"> failed: </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">instance</span><span class="p">,</span> <span class="n">ex</span><span class="o">.</span><span class="n">content</span><span class="p">)</span></div> |
| <span class="p">)</span> |
| |
| <span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">fallback_to_default_project_id</span> |
| <div class="viewcode-block" id="CloudSqlHook.import_instance"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_sql_hook/index.html#airflow.contrib.hooks.gcp_sql_hook.CloudSqlHook.import_instance">[docs]</a> <span class="k">def</span> <span class="nf">import_instance</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">instance</span><span class="p">,</span> <span class="n">body</span><span class="p">,</span> <span class="n">project_id</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Imports data into a Cloud SQL instance from a SQL dump or CSV file in</span> |
| <span class="sd"> Cloud Storage.</span> |
| |
| <span class="sd"> :param instance: Database instance ID. This does not include the</span> |
| <span class="sd"> project ID.</span> |
| <span class="sd"> :type instance: str</span> |
| <span class="sd"> :param body: The request body, as described in</span> |
| <span class="sd"> https://cloud.google.com/sql/docs/mysql/admin-api/v1beta4/instances/export#request-body</span> |
| <span class="sd"> :type body: dict</span> |
| <span class="sd"> :param project_id: Project ID of the project that contains the instance. If set</span> |
| <span class="sd"> to None or missing, the default project_id from the GCP connection is used.</span> |
| <span class="sd"> :type project_id: str</span> |
| <span class="sd"> :return: None</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="bp">self</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span><span class="o">.</span><span class="n">instances</span><span class="p">()</span><span class="o">.</span><span class="n">import_</span><span class="p">(</span> |
| <span class="n">project</span><span class="o">=</span><span class="n">project_id</span><span class="p">,</span> |
| <span class="n">instance</span><span class="o">=</span><span class="n">instance</span><span class="p">,</span> |
| <span class="n">body</span><span class="o">=</span><span class="n">body</span> |
| <span class="p">)</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">num_retries</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">num_retries</span><span class="p">)</span> |
| <span class="n">operation_name</span> <span class="o">=</span> <span class="n">response</span><span class="p">[</span><span class="s2">"name"</span><span class="p">]</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_wait_for_operation_to_complete</span><span class="p">(</span><span class="n">project_id</span><span class="o">=</span><span class="n">project_id</span><span class="p">,</span> |
| <span class="n">operation_name</span><span class="o">=</span><span class="n">operation_name</span><span class="p">)</span> |
| <span class="k">except</span> <span class="n">HttpError</span> <span class="k">as</span> <span class="n">ex</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span> |
| <span class="s1">'Importing instance </span><span class="si">{}</span><span class="s1"> failed: </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">instance</span><span class="p">,</span> <span class="n">ex</span><span class="o">.</span><span class="n">content</span><span class="p">)</span></div> |
| <span class="p">)</span> |
| |
| <div class="viewcode-block" id="CloudSqlHook._wait_for_operation_to_complete"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_sql_hook/index.html#airflow.contrib.hooks.gcp_sql_hook.CloudSqlHook._wait_for_operation_to_complete">[docs]</a> <span class="k">def</span> <span class="nf">_wait_for_operation_to_complete</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">project_id</span><span class="p">,</span> <span class="n">operation_name</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Waits for the named operation to complete - checks status of the</span> |
| <span class="sd"> asynchronous call.</span> |
| |
| <span class="sd"> :param project_id: Project ID of the project that contains the instance.</span> |
| <span class="sd"> :type project_id: str</span> |
| <span class="sd"> :param operation_name: Name of the operation.</span> |
| <span class="sd"> :type operation_name: str</span> |
| <span class="sd"> :return: None</span> |
| <span class="sd"> """</span> |
| <span class="n">service</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="k">while</span> <span class="kc">True</span><span class="p">:</span> |
| <span class="n">operation_response</span> <span class="o">=</span> <span class="n">service</span><span class="o">.</span><span class="n">operations</span><span class="p">()</span><span class="o">.</span><span class="n">get</span><span class="p">(</span> |
| <span class="n">project</span><span class="o">=</span><span class="n">project_id</span><span class="p">,</span> |
| <span class="n">operation</span><span class="o">=</span><span class="n">operation_name</span><span class="p">,</span> |
| <span class="p">)</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">num_retries</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">num_retries</span><span class="p">)</span> |
| <span class="k">if</span> <span class="n">operation_response</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"status"</span><span class="p">)</span> <span class="o">==</span> <span class="n">CloudSqlOperationStatus</span><span class="o">.</span><span class="n">DONE</span><span class="p">:</span> |
| <span class="n">error</span> <span class="o">=</span> <span class="n">operation_response</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"error"</span><span class="p">)</span> |
| <span class="k">if</span> <span class="n">error</span><span class="p">:</span> |
| <span class="c1"># Extracting the errors list as string and trimming square braces</span> |
| <span class="n">error_msg</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">error</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"errors"</span><span class="p">))[</span><span class="mi">1</span><span class="p">:</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="n">error_msg</span><span class="p">)</span> |
| <span class="c1"># No meaningful info to return from the response in case of success</span> |
| <span class="k">return</span> |
| <span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="n">TIME_TO_SLEEP_IN_SECONDS</span><span class="p">)</span></div></div> |
| |
| |
| <div class="viewcode-block" id="CLOUD_SQL_PROXY_DOWNLOAD_URL"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_sql_hook/index.html#airflow.contrib.hooks.gcp_sql_hook.CLOUD_SQL_PROXY_DOWNLOAD_URL">[docs]</a><span class="n">CLOUD_SQL_PROXY_DOWNLOAD_URL</span> <span class="o">=</span> <span class="s2">"https://dl.google.com/cloudsql/cloud_sql_proxy.</span><span class="si">{}</span><span class="s2">.</span><span class="si">{}</span><span class="s2">"</span></div> |
| <div class="viewcode-block" id="CLOUD_SQL_PROXY_VERSION_DOWNLOAD_URL"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_sql_hook/index.html#airflow.contrib.hooks.gcp_sql_hook.CLOUD_SQL_PROXY_VERSION_DOWNLOAD_URL">[docs]</a><span class="n">CLOUD_SQL_PROXY_VERSION_DOWNLOAD_URL</span> <span class="o">=</span> \ |
| <span class="s2">"https://storage.googleapis.com/cloudsql-proxy/</span><span class="si">{}</span><span class="s2">/cloud_sql_proxy.</span><span class="si">{}</span><span class="s2">.</span><span class="si">{}</span><span class="s2">"</span></div> |
| |
| <div class="viewcode-block" id="GCP_CREDENTIALS_KEY_PATH"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_sql_hook/index.html#airflow.contrib.hooks.gcp_sql_hook.GCP_CREDENTIALS_KEY_PATH">[docs]</a><span class="n">GCP_CREDENTIALS_KEY_PATH</span> <span class="o">=</span> <span class="s2">"extra__google_cloud_platform__key_path"</span></div> |
| <div class="viewcode-block" id="GCP_CREDENTIALS_KEYFILE_DICT"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_sql_hook/index.html#airflow.contrib.hooks.gcp_sql_hook.GCP_CREDENTIALS_KEYFILE_DICT">[docs]</a><span class="n">GCP_CREDENTIALS_KEYFILE_DICT</span> <span class="o">=</span> <span class="s2">"extra__google_cloud_platform__keyfile_dict"</span></div> |
| |
| |
| <div class="viewcode-block" id="CloudSqlProxyRunner"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_sql_hook/index.html#airflow.contrib.hooks.gcp_sql_hook.CloudSqlProxyRunner">[docs]</a><span class="k">class</span> <span class="nc">CloudSqlProxyRunner</span><span class="p">(</span><span class="n">LoggingMixin</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Downloads and runs cloud-sql-proxy as subprocess of the Python process.</span> |
| |
| <span class="sd"> The cloud-sql-proxy needs to be downloaded and started before we can connect</span> |
| <span class="sd"> to the Google Cloud SQL instance via database connection. It establishes</span> |
| <span class="sd"> secure tunnel connection to the database. It authorizes using the</span> |
| <span class="sd"> GCP credentials that are passed by the configuration.</span> |
| |
| <span class="sd"> More details about the proxy can be found here:</span> |
| <span class="sd"> https://cloud.google.com/sql/docs/mysql/sql-proxy</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">path_prefix</span><span class="p">,</span> |
| <span class="n">instance_specification</span><span class="p">,</span> |
| <span class="n">gcp_conn_id</span><span class="o">=</span><span class="s1">'google_cloud_default'</span><span class="p">,</span> |
| <span class="n">project_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">sql_proxy_version</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">sql_proxy_binary_path</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Creates the proxy runner class.</span> |
| |
| <span class="sd"> :param path_prefix: Unique path prefix where proxy will be downloaded and</span> |
| <span class="sd"> directories created for unix sockets.</span> |
| <span class="sd"> :type path_prefix: str</span> |
| <span class="sd"> :param instance_specification: Specification of the instance to connect the</span> |
| <span class="sd"> proxy to. It should be specified in the form that is described in</span> |
| <span class="sd"> https://cloud.google.com/sql/docs/mysql/sql-proxy#multiple-instances in</span> |
| <span class="sd"> -instances parameter (typically in the form of ``<project>:<region>:<instance>``</span> |
| <span class="sd"> for UNIX socket connections and in the form of</span> |
| <span class="sd"> ``<project>:<region>:<instance>=tcp:<port>`` for TCP connections.</span> |
| <span class="sd"> :type instance_specification: str</span> |
| <span class="sd"> :param gcp_conn_id: Id of Google Cloud Platform connection to use for</span> |
| <span class="sd"> authentication</span> |
| <span class="sd"> :type gcp_conn_id: str</span> |
| <span class="sd"> :param project_id: Optional id of the GCP project to connect to - it overwrites</span> |
| <span class="sd"> default project id taken from the GCP connection.</span> |
| <span class="sd"> :type project_id: str</span> |
| <span class="sd"> :param sql_proxy_version: Specific version of SQL proxy to download</span> |
| <span class="sd"> (for example 'v1.13'). By default latest version is downloaded.</span> |
| <span class="sd"> :type sql_proxy_version: str</span> |
| <span class="sd"> :param sql_proxy_binary_path: If specified, then proxy will be</span> |
| <span class="sd"> used from the path specified rather than dynamically generated. This means</span> |
| <span class="sd"> that if the binary is not present in that path it will also be downloaded.</span> |
| <span class="sd"> :type sql_proxy_binary_path: str</span> |
| <span class="sd"> """</span> |
| <span class="nb">super</span><span class="p">(</span><span class="n">CloudSqlProxyRunner</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="bp">self</span><span class="o">.</span><span class="n">path_prefix</span> <span class="o">=</span> <span class="n">path_prefix</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">path_prefix</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s2">"The path_prefix must not be empty!"</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">sql_proxy_was_downloaded</span> <span class="o">=</span> <span class="kc">False</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">sql_proxy_version</span> <span class="o">=</span> <span class="n">sql_proxy_version</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">download_sql_proxy_dir</span> <span class="o">=</span> <span class="kc">None</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">sql_proxy_process</span> <span class="o">=</span> <span class="kc">None</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">instance_specification</span> <span class="o">=</span> <span class="n">instance_specification</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">project_id</span> <span class="o">=</span> <span class="n">project_id</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">gcp_conn_id</span> <span class="o">=</span> <span class="n">gcp_conn_id</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">command_line_parameters</span> <span class="o">=</span> <span class="p">[]</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">cloud_sql_proxy_socket_directory</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">path_prefix</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">sql_proxy_path</span> <span class="o">=</span> <span class="n">sql_proxy_binary_path</span> <span class="k">if</span> <span class="n">sql_proxy_binary_path</span> \ |
| <span class="k">else</span> <span class="bp">self</span><span class="o">.</span><span class="n">path_prefix</span> <span class="o">+</span> <span class="s2">"_cloud_sql_proxy"</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">credentials_path</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">path_prefix</span> <span class="o">+</span> <span class="s2">"_credentials.json"</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_build_command_line_parameters</span><span class="p">()</span> |
| |
| <div class="viewcode-block" id="CloudSqlProxyRunner._build_command_line_parameters"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_sql_hook/index.html#airflow.contrib.hooks.gcp_sql_hook.CloudSqlProxyRunner._build_command_line_parameters">[docs]</a> <span class="k">def</span> <span class="nf">_build_command_line_parameters</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">command_line_parameters</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span> |
| <span class="p">[</span><span class="s1">'-dir'</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">cloud_sql_proxy_socket_directory</span><span class="p">])</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">command_line_parameters</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span> |
| <span class="p">[</span><span class="s1">'-instances'</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">instance_specification</span><span class="p">])</span></div> |
| |
| <span class="nd">@staticmethod</span> |
| <div class="viewcode-block" id="CloudSqlProxyRunner._is_os_64bit"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_sql_hook/index.html#airflow.contrib.hooks.gcp_sql_hook.CloudSqlProxyRunner._is_os_64bit">[docs]</a> <span class="k">def</span> <span class="nf">_is_os_64bit</span><span class="p">():</span> |
| <span class="k">return</span> <span class="n">platform</span><span class="o">.</span><span class="n">machine</span><span class="p">()</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s1">'64'</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="CloudSqlProxyRunner._download_sql_proxy_if_needed"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_sql_hook/index.html#airflow.contrib.hooks.gcp_sql_hook.CloudSqlProxyRunner._download_sql_proxy_if_needed">[docs]</a> <span class="k">def</span> <span class="nf">_download_sql_proxy_if_needed</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">if</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="bp">self</span><span class="o">.</span><span class="n">sql_proxy_path</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="s2">"cloud-sql-proxy is already present"</span><span class="p">)</span> |
| <span class="k">return</span> |
| <span class="n">system</span> <span class="o">=</span> <span class="n">platform</span><span class="o">.</span><span class="n">system</span><span class="p">()</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> |
| <span class="n">processor</span> <span class="o">=</span> <span class="s2">"amd64"</span> <span class="k">if</span> <span class="n">CloudSqlProxyRunner</span><span class="o">.</span><span class="n">_is_os_64bit</span><span class="p">()</span> <span class="k">else</span> <span class="s2">"386"</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">sql_proxy_version</span><span class="p">:</span> |
| <span class="n">download_url</span> <span class="o">=</span> <span class="n">CLOUD_SQL_PROXY_DOWNLOAD_URL</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">system</span><span class="p">,</span> <span class="n">processor</span><span class="p">)</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="n">download_url</span> <span class="o">=</span> <span class="n">CLOUD_SQL_PROXY_VERSION_DOWNLOAD_URL</span><span class="o">.</span><span class="n">format</span><span class="p">(</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">sql_proxy_version</span><span class="p">,</span> <span class="n">system</span><span class="p">,</span> <span class="n">processor</span><span class="p">)</span> |
| <span class="n">proxy_path_tmp</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">sql_proxy_path</span> <span class="o">+</span> <span class="s2">".tmp"</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="s2">"Downloading cloud_sql_proxy from </span><span class="si">%s</span><span class="s2"> to </span><span class="si">%s</span><span class="s2">"</span><span class="p">,</span> |
| <span class="n">download_url</span><span class="p">,</span> <span class="n">proxy_path_tmp</span><span class="p">)</span> |
| <span class="n">r</span> <span class="o">=</span> <span class="n">requests</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">download_url</span><span class="p">,</span> <span class="n">allow_redirects</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> |
| <span class="c1"># Downloading to .tmp file first to avoid case where partially downloaded</span> |
| <span class="c1"># binary is used by parallel operator which uses the same fixed binary path</span> |
| <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">proxy_path_tmp</span><span class="p">,</span> <span class="s1">'wb'</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span> |
| <span class="n">f</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">r</span><span class="o">.</span><span class="n">content</span><span class="p">)</span> |
| <span class="k">if</span> <span class="n">r</span><span class="o">.</span><span class="n">status_code</span> <span class="o">!=</span> <span class="mi">200</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span> |
| <span class="s2">"The cloud-sql-proxy could not be downloaded. Status code = </span><span class="si">{}</span><span class="s2">. "</span> |
| <span class="s2">"Reason = </span><span class="si">{}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">r</span><span class="o">.</span><span class="n">status_code</span><span class="p">,</span> <span class="n">r</span><span class="o">.</span><span class="n">reason</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="s2">"Moving sql_proxy binary from </span><span class="si">%s</span><span class="s2"> to </span><span class="si">%s</span><span class="s2">"</span><span class="p">,</span> |
| <span class="n">proxy_path_tmp</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">sql_proxy_path</span><span class="p">)</span> |
| <span class="n">shutil</span><span class="o">.</span><span class="n">move</span><span class="p">(</span><span class="n">proxy_path_tmp</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">sql_proxy_path</span><span class="p">)</span> |
| <span class="n">os</span><span class="o">.</span><span class="n">chmod</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">sql_proxy_path</span><span class="p">,</span> <span class="mo">0o744</span><span class="p">)</span> <span class="c1"># Set executable bit</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">sql_proxy_was_downloaded</span> <span class="o">=</span> <span class="kc">True</span></div> |
| |
| <span class="nd">@provide_session</span> |
| <div class="viewcode-block" id="CloudSqlProxyRunner._get_credential_parameters"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_sql_hook/index.html#airflow.contrib.hooks.gcp_sql_hook.CloudSqlProxyRunner._get_credential_parameters">[docs]</a> <span class="k">def</span> <span class="nf">_get_credential_parameters</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">connection</span> <span class="o">=</span> <span class="n">session</span><span class="o">.</span><span class="n">query</span><span class="p">(</span><span class="n">Connection</span><span class="p">)</span><span class="o">.</span> \ |
| <span class="nb">filter</span><span class="p">(</span><span class="n">Connection</span><span class="o">.</span><span class="n">conn_id</span> <span class="o">==</span> <span class="bp">self</span><span class="o">.</span><span class="n">gcp_conn_id</span><span class="p">)</span><span class="o">.</span><span class="n">first</span><span class="p">()</span> |
| <span class="n">session</span><span class="o">.</span><span class="n">expunge_all</span><span class="p">()</span> |
| <span class="k">if</span> <span class="n">GCP_CREDENTIALS_KEY_PATH</span> <span class="ow">in</span> <span class="n">connection</span><span class="o">.</span><span class="n">extra_dejson</span><span class="p">:</span> |
| <span class="n">credential_params</span> <span class="o">=</span> <span class="p">[</span> |
| <span class="s1">'-credential_file'</span><span class="p">,</span> |
| <span class="n">connection</span><span class="o">.</span><span class="n">extra_dejson</span><span class="p">[</span><span class="n">GCP_CREDENTIALS_KEY_PATH</span><span class="p">]</span> |
| <span class="p">]</span> |
| <span class="k">elif</span> <span class="n">GCP_CREDENTIALS_KEYFILE_DICT</span> <span class="ow">in</span> <span class="n">connection</span><span class="o">.</span><span class="n">extra_dejson</span><span class="p">:</span> |
| <span class="n">credential_file_content</span> <span class="o">=</span> <span class="n">json</span><span class="o">.</span><span class="n">loads</span><span class="p">(</span> |
| <span class="n">connection</span><span class="o">.</span><span class="n">extra_dejson</span><span class="p">[</span><span class="n">GCP_CREDENTIALS_KEYFILE_DICT</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="s2">"Saving credentials to </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">credentials_path</span><span class="p">)</span> |
| <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">credentials_path</span><span class="p">,</span> <span class="s2">"w"</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span> |
| <span class="n">json</span><span class="o">.</span><span class="n">dump</span><span class="p">(</span><span class="n">credential_file_content</span><span class="p">,</span> <span class="n">f</span><span class="p">)</span> |
| <span class="n">credential_params</span> <span class="o">=</span> <span class="p">[</span> |
| <span class="s1">'-credential_file'</span><span class="p">,</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">credentials_path</span> |
| <span class="p">]</span> |
| <span class="k">else</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="s2">"The credentials are not supplied by neither key_path nor "</span> |
| <span class="s2">"keyfile_dict of the gcp connection </span><span class="si">%s</span><span class="s2">. Falling back to "</span> |
| <span class="s2">"default activated account"</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">gcp_conn_id</span><span class="p">)</span> |
| <span class="n">credential_params</span> <span class="o">=</span> <span class="p">[]</span> |
| |
| <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">instance_specification</span><span class="p">:</span> |
| <span class="n">project_id</span> <span class="o">=</span> <span class="n">connection</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__google_cloud_platform__project'</span><span class="p">)</span> |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">project_id</span><span class="p">:</span> |
| <span class="n">project_id</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">project_id</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="n">project_id</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s2">"For forwarding all instances, the project id "</span> |
| <span class="s2">"for GCP should be provided either "</span> |
| <span class="s2">"by project_id extra in the GCP connection or by "</span> |
| <span class="s2">"project_id provided in the operator."</span><span class="p">)</span> |
| <span class="n">credential_params</span><span class="o">.</span><span class="n">extend</span><span class="p">([</span><span class="s1">'-projects'</span><span class="p">,</span> <span class="n">project_id</span><span class="p">])</span> |
| <span class="k">return</span> <span class="n">credential_params</span></div> |
| |
| <div class="viewcode-block" id="CloudSqlProxyRunner.start_proxy"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_sql_hook/index.html#airflow.contrib.hooks.gcp_sql_hook.CloudSqlProxyRunner.start_proxy">[docs]</a> <span class="k">def</span> <span class="nf">start_proxy</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Starts Cloud SQL Proxy.</span> |
| |
| <span class="sd"> You have to remember to stop the proxy if you started it!</span> |
| <span class="sd"> """</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_download_sql_proxy_if_needed</span><span class="p">()</span> |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">sql_proxy_process</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s2">"The sql proxy is already running: </span><span class="si">{}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">sql_proxy_process</span><span class="p">))</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="n">command_to_run</span> <span class="o">=</span> <span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">sql_proxy_path</span><span class="p">]</span> |
| <span class="n">command_to_run</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">command_line_parameters</span><span class="p">)</span> |
| <span class="k">try</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="s2">"Creating directory </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">cloud_sql_proxy_socket_directory</span><span class="p">)</span> |
| <span class="n">os</span><span class="o">.</span><span class="n">makedirs</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">cloud_sql_proxy_socket_directory</span><span class="p">)</span> |
| <span class="k">except</span> <span class="ne">OSError</span><span class="p">:</span> |
| <span class="c1"># Needed for python 2 compatibility (exists_ok missing)</span> |
| <span class="k">pass</span> |
| <span class="n">command_to_run</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_get_credential_parameters</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="s2">"Running the command: `</span><span class="si">%s</span><span class="s2">`"</span><span class="p">,</span> <span class="s2">" "</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">command_to_run</span><span class="p">))</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">sql_proxy_process</span> <span class="o">=</span> <span class="n">Popen</span><span class="p">(</span><span class="n">command_to_run</span><span class="p">,</span> |
| <span class="n">stdin</span><span class="o">=</span><span class="n">PIPE</span><span class="p">,</span> <span class="n">stdout</span><span class="o">=</span><span class="n">PIPE</span><span class="p">,</span> <span class="n">stderr</span><span class="o">=</span><span class="n">PIPE</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="s2">"The pid of cloud_sql_proxy: </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">sql_proxy_process</span><span class="o">.</span><span class="n">pid</span><span class="p">)</span> |
| <span class="k">while</span> <span class="kc">True</span><span class="p">:</span> |
| <span class="n">line</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">sql_proxy_process</span><span class="o">.</span><span class="n">stderr</span><span class="o">.</span><span class="n">readline</span><span class="p">()</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s1">'utf-8'</span><span class="p">)</span> |
| <span class="n">return_code</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">sql_proxy_process</span><span class="o">.</span><span class="n">poll</span><span class="p">()</span> |
| <span class="k">if</span> <span class="n">line</span> <span class="o">==</span> <span class="s1">''</span> <span class="ow">and</span> <span class="n">return_code</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">sql_proxy_process</span> <span class="o">=</span> <span class="kc">None</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span> |
| <span class="s2">"The cloud_sql_proxy finished early with return code </span><span class="si">{}</span><span class="s2">!"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span> |
| <span class="n">return_code</span><span class="p">))</span> |
| <span class="k">if</span> <span class="n">line</span> <span class="o">!=</span> <span class="s1">''</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="n">line</span><span class="p">)</span> |
| <span class="k">if</span> <span class="s2">"googleapi: Error"</span> <span class="ow">in</span> <span class="n">line</span> <span class="ow">or</span> <span class="s2">"invalid instance name:"</span> <span class="ow">in</span> <span class="n">line</span><span class="p">:</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">stop_proxy</span><span class="p">()</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span> |
| <span class="s2">"Error when starting the cloud_sql_proxy </span><span class="si">{}</span><span class="s2">!"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span> |
| <span class="n">line</span><span class="p">))</span> |
| <span class="k">if</span> <span class="s2">"Ready for new connections"</span> <span class="ow">in</span> <span class="n">line</span><span class="p">:</span> |
| <span class="k">return</span></div> |
| |
| <div class="viewcode-block" id="CloudSqlProxyRunner.stop_proxy"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_sql_hook/index.html#airflow.contrib.hooks.gcp_sql_hook.CloudSqlProxyRunner.stop_proxy">[docs]</a> <span class="k">def</span> <span class="nf">stop_proxy</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Stops running proxy.</span> |
| |
| <span class="sd"> You should stop the proxy after you stop using it.</span> |
| <span class="sd"> """</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">sql_proxy_process</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s2">"The sql proxy is not started yet"</span><span class="p">)</span> |
| <span class="k">else</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="s2">"Stopping the cloud_sql_proxy pid: </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">sql_proxy_process</span><span class="o">.</span><span class="n">pid</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">sql_proxy_process</span><span class="o">.</span><span class="n">kill</span><span class="p">()</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">sql_proxy_process</span> <span class="o">=</span> <span class="kc">None</span> |
| <span class="c1"># Cleanup!</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="s2">"Removing the socket directory: </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">cloud_sql_proxy_socket_directory</span><span class="p">)</span> |
| <span class="n">shutil</span><span class="o">.</span><span class="n">rmtree</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">cloud_sql_proxy_socket_directory</span><span class="p">,</span> <span class="n">ignore_errors</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">sql_proxy_was_downloaded</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="s2">"Removing downloaded proxy: </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">sql_proxy_path</span><span class="p">)</span> |
| <span class="c1"># Silently ignore if the file has already been removed (concurrency)</span> |
| <span class="k">try</span><span class="p">:</span> |
| <span class="n">os</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">sql_proxy_path</span><span class="p">)</span> |
| <span class="k">except</span> <span class="ne">OSError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="n">e</span><span class="o">.</span><span class="n">errno</span> <span class="o">==</span> <span class="n">errno</span><span class="o">.</span><span class="n">ENOENT</span><span class="p">:</span> |
| <span class="k">raise</span> |
| <span class="k">else</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="s2">"Skipped removing proxy - it was not downloaded: </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">sql_proxy_path</span><span class="p">)</span> |
| <span class="k">if</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="bp">self</span><span class="o">.</span><span class="n">credentials_path</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="s2">"Removing generated credentials file </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">credentials_path</span><span class="p">)</span> |
| <span class="c1"># Here file cannot be delete by concurrent task (each task has its own copy)</span> |
| <span class="n">os</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">credentials_path</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="CloudSqlProxyRunner.get_proxy_version"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_sql_hook/index.html#airflow.contrib.hooks.gcp_sql_hook.CloudSqlProxyRunner.get_proxy_version">[docs]</a> <span class="k">def</span> <span class="nf">get_proxy_version</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Returns version of the Cloud SQL Proxy.</span> |
| <span class="sd"> """</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_download_sql_proxy_if_needed</span><span class="p">()</span> |
| <span class="n">command_to_run</span> <span class="o">=</span> <span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">sql_proxy_path</span><span class="p">]</span> |
| <span class="n">command_to_run</span><span class="o">.</span><span class="n">extend</span><span class="p">([</span><span class="s1">'--version'</span><span class="p">])</span> |
| <span class="n">command_to_run</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_get_credential_parameters</span><span class="p">())</span> |
| <span class="n">result</span> <span class="o">=</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">check_output</span><span class="p">(</span><span class="n">command_to_run</span><span class="p">)</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s1">'utf-8'</span><span class="p">)</span> |
| <span class="n">pattern</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="s2">"^.*[V|v]ersion ([^;]*);.*$"</span><span class="p">)</span> |
| <span class="n">m</span> <span class="o">=</span> <span class="n">pattern</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">result</span><span class="p">)</span> |
| <span class="k">if</span> <span class="n">m</span><span class="p">:</span> |
| <span class="k">return</span> <span class="n">m</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="k">return</span> <span class="kc">None</span></div> |
| |
| <div class="viewcode-block" id="CloudSqlProxyRunner.get_socket_path"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_sql_hook/index.html#airflow.contrib.hooks.gcp_sql_hook.CloudSqlProxyRunner.get_socket_path">[docs]</a> <span class="k">def</span> <span class="nf">get_socket_path</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Retrieves UNIX socket path used by Cloud SQL Proxy.</span> |
| |
| <span class="sd"> :return: The dynamically generated path for the socket created by the proxy.</span> |
| <span class="sd"> :rtype: str</span> |
| <span class="sd"> """</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">cloud_sql_proxy_socket_directory</span> <span class="o">+</span> <span class="s2">"/"</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">instance_specification</span></div></div> |
| |
| |
| <div class="viewcode-block" id="CONNECTION_URIS"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_sql_hook/index.html#airflow.contrib.hooks.gcp_sql_hook.CONNECTION_URIS">[docs]</a><span class="n">CONNECTION_URIS</span> <span class="o">=</span> <span class="p">{</span> |
| <span class="s2">"postgres"</span><span class="p">:</span> <span class="p">{</span> |
| <span class="s2">"proxy"</span><span class="p">:</span> <span class="p">{</span> |
| <span class="s2">"tcp"</span><span class="p">:</span> |
| <span class="s2">"postgresql://</span><span class="si">{user}</span><span class="s2">:</span><span class="si">{password}</span><span class="s2">@127.0.0.1:</span><span class="si">{proxy_port}</span><span class="s2">/</span><span class="si">{database}</span><span class="s2">"</span><span class="p">,</span> |
| <span class="s2">"socket"</span><span class="p">:</span> |
| <span class="s2">"postgresql://</span><span class="si">{user}</span><span class="s2">:</span><span class="si">{password}</span><span class="s2">@</span><span class="si">{socket_path}</span><span class="s2">/</span><span class="si">{database}</span><span class="s2">"</span> |
| <span class="p">},</span> |
| <span class="s2">"public"</span><span class="p">:</span> <span class="p">{</span> |
| <span class="s2">"ssl"</span><span class="p">:</span> |
| <span class="s2">"postgresql://</span><span class="si">{user}</span><span class="s2">:</span><span class="si">{password}</span><span class="s2">@</span><span class="si">{public_ip}</span><span class="s2">:</span><span class="si">{public_port}</span><span class="s2">/</span><span class="si">{database}</span><span class="s2">?"</span> |
| <span class="s2">"sslmode=verify-ca&"</span> |
| <span class="s2">"sslcert=</span><span class="si">{client_cert_file}</span><span class="s2">&"</span> |
| <span class="s2">"sslkey=</span><span class="si">{client_key_file}</span><span class="s2">&"</span> |
| <span class="s2">"sslrootcert=</span><span class="si">{server_ca_file}</span><span class="s2">"</span><span class="p">,</span> |
| <span class="s2">"non-ssl"</span><span class="p">:</span> |
| <span class="s2">"postgresql://</span><span class="si">{user}</span><span class="s2">:</span><span class="si">{password}</span><span class="s2">@</span><span class="si">{public_ip}</span><span class="s2">:</span><span class="si">{public_port}</span><span class="s2">/</span><span class="si">{database}</span><span class="s2">"</span> |
| <span class="p">}</span> |
| <span class="p">},</span> |
| <span class="s2">"mysql"</span><span class="p">:</span> <span class="p">{</span> |
| <span class="s2">"proxy"</span><span class="p">:</span> <span class="p">{</span> |
| <span class="s2">"tcp"</span><span class="p">:</span> |
| <span class="s2">"mysql://</span><span class="si">{user}</span><span class="s2">:</span><span class="si">{password}</span><span class="s2">@127.0.0.1:</span><span class="si">{proxy_port}</span><span class="s2">/</span><span class="si">{database}</span><span class="s2">"</span><span class="p">,</span> |
| <span class="s2">"socket"</span><span class="p">:</span> |
| <span class="s2">"mysql://</span><span class="si">{user}</span><span class="s2">:</span><span class="si">{password}</span><span class="s2">@localhost/</span><span class="si">{database}</span><span class="s2">?"</span> |
| <span class="s2">"unix_socket=</span><span class="si">{socket_path}</span><span class="s2">"</span> |
| <span class="p">},</span> |
| <span class="s2">"public"</span><span class="p">:</span> <span class="p">{</span> |
| <span class="s2">"ssl"</span><span class="p">:</span> |
| <span class="s2">"mysql://</span><span class="si">{user}</span><span class="s2">:</span><span class="si">{password}</span><span class="s2">@</span><span class="si">{public_ip}</span><span class="s2">:</span><span class="si">{public_port}</span><span class="s2">/</span><span class="si">{database}</span><span class="s2">?"</span> |
| <span class="s2">"ssl=</span><span class="si">{ssl_spec}</span><span class="s2">"</span><span class="p">,</span> |
| <span class="s2">"non-ssl"</span><span class="p">:</span> |
| <span class="s2">"mysql://</span><span class="si">{user}</span><span class="s2">:</span><span class="si">{password}</span><span class="s2">@</span><span class="si">{public_ip}</span><span class="s2">:</span><span class="si">{public_port}</span><span class="s2">/</span><span class="si">{database}</span><span class="s2">"</span></div> |
| <span class="p">}</span> |
| <span class="p">}</span> |
| <span class="p">}</span> |
| |
| <div class="viewcode-block" id="CLOUD_SQL_VALID_DATABASE_TYPES"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_sql_hook/index.html#airflow.contrib.hooks.gcp_sql_hook.CLOUD_SQL_VALID_DATABASE_TYPES">[docs]</a><span class="n">CLOUD_SQL_VALID_DATABASE_TYPES</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'postgres'</span><span class="p">,</span> <span class="s1">'mysql'</span><span class="p">]</span></div> |
| |
| |
| <span class="c1"># noinspection PyAbstractClass</span> |
| <div class="viewcode-block" id="CloudSqlDatabaseHook"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_sql_hook/index.html#airflow.contrib.hooks.gcp_sql_hook.CloudSqlDatabaseHook">[docs]</a><span class="k">class</span> <span class="nc">CloudSqlDatabaseHook</span><span class="p">(</span><span class="n">BaseHook</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Serves DB connection configuration for Google Cloud SQL (Connections</span> |
| <span class="sd"> of *gcpcloudsql://* type).</span> |
| |
| <span class="sd"> The hook is a "meta" one. It does not perform an actual connection.</span> |
| <span class="sd"> It is there to retrieve all the parameters configured in gcpcloudsql:// connection,</span> |
| <span class="sd"> start/stop Cloud SQL Proxy if needed, dynamically generate Postgres or MySQL</span> |
| <span class="sd"> connection in the database and return an actual Postgres or MySQL hook.</span> |
| <span class="sd"> The returned Postgres/MySQL hooks are using direct connection or Cloud SQL</span> |
| <span class="sd"> Proxy socket/TCP as configured.</span> |
| |
| <span class="sd"> Main parameters of the hook are retrieved from the standard URI components:</span> |
| |
| <span class="sd"> * **user** - User name to authenticate to the database (from login of the URI).</span> |
| <span class="sd"> * **password** - Password to authenticate to the database (from password of the URI).</span> |
| <span class="sd"> * **public_ip** - IP to connect to for public connection (from host of the URI).</span> |
| <span class="sd"> * **public_port** - Port to connect to for public connection (from port of the URI).</span> |
| <span class="sd"> * **database** - Database to connect to (from schema of the URI).</span> |
| |
| <span class="sd"> Remaining parameters are retrieved from the extras (URI query parameters):</span> |
| |
| <span class="sd"> * **project_id** - Optional, Google Cloud Platform project where the Cloud SQL</span> |
| <span class="sd"> instance exists. If missing, default project id passed is used.</span> |
| <span class="sd"> * **instance** - Name of the instance of the Cloud SQL database instance.</span> |
| <span class="sd"> * **location** - The location of the Cloud SQL instance (for example europe-west1).</span> |
| <span class="sd"> * **database_type** - The type of the database instance (MySQL or Postgres).</span> |
| <span class="sd"> * **use_proxy** - (default False) Whether SQL proxy should be used to connect to Cloud</span> |
| <span class="sd"> SQL DB.</span> |
| <span class="sd"> * **use_ssl** - (default False) Whether SSL should be used to connect to Cloud SQL DB.</span> |
| <span class="sd"> You cannot use proxy and SSL together.</span> |
| <span class="sd"> * **sql_proxy_use_tcp** - (default False) If set to true, TCP is used to connect via</span> |
| <span class="sd"> proxy, otherwise UNIX sockets are used.</span> |
| <span class="sd"> * **sql_proxy_binary_path** - Optional path to Cloud SQL Proxy binary. If the binary</span> |
| <span class="sd"> is not specified or the binary is not present, it is automatically downloaded.</span> |
| <span class="sd"> * **sql_proxy_version** - Specific version of the proxy to download (for example</span> |
| <span class="sd"> v1.13). If not specified, the latest version is downloaded.</span> |
| <span class="sd"> * **sslcert** - Path to client certificate to authenticate when SSL is used.</span> |
| <span class="sd"> * **sslkey** - Path to client private key to authenticate when SSL is used.</span> |
| <span class="sd"> * **sslrootcert** - Path to server's certificate to authenticate when SSL is used.</span> |
| |
| <span class="sd"> :param gcp_cloudsql_conn_id: URL of the connection</span> |
| <span class="sd"> :type gcp_cloudsql_conn_id: str</span> |
| <span class="sd"> :param gcp_conn_id: The connection ID used to connect to Google Cloud Platform for</span> |
| <span class="sd"> cloud-sql-proxy authentication.</span> |
| <span class="sd"> :type gcp_conn_id: str</span> |
| <span class="sd"> :param default_gcp_project_id: Default project id used if project_id not specified</span> |
| <span class="sd"> in the connection URL</span> |
| <span class="sd"> :type default_gcp_project_id: str</span> |
| <span class="sd"> """</span> |
| <div class="viewcode-block" id="CloudSqlDatabaseHook._conn"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_sql_hook/index.html#airflow.contrib.hooks.gcp_sql_hook.CloudSqlDatabaseHook._conn">[docs]</a> <span class="n">_conn</span> <span class="o">=</span> <span class="kc">None</span></div> |
| |
| <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">gcp_cloudsql_conn_id</span><span class="o">=</span><span class="s1">'google_cloud_sql_default'</span><span class="p">,</span> |
| <span class="n">gcp_conn_id</span><span class="o">=</span><span class="s1">'google_cloud_default'</span><span class="p">,</span> <span class="n">default_gcp_project_id</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="nb">super</span><span class="p">(</span><span class="n">CloudSqlDatabaseHook</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="n">source</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">gcp_conn_id</span> <span class="o">=</span> <span class="n">gcp_conn_id</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">gcp_cloudsql_conn_id</span> <span class="o">=</span> <span class="n">gcp_cloudsql_conn_id</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">cloudsql_connection</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">gcp_cloudsql_conn_id</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">extras</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">cloudsql_connection</span><span class="o">.</span><span class="n">extra_dejson</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">project_id</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">extras</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'project_id'</span><span class="p">,</span> <span class="n">default_gcp_project_id</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">instance</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">extras</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'instance'</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">database</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">cloudsql_connection</span><span class="o">.</span><span class="n">schema</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">location</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">extras</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'location'</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">database_type</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">extras</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'database_type'</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">use_proxy</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_bool</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">extras</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'use_proxy'</span><span class="p">,</span> <span class="s1">'False'</span><span class="p">))</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">use_ssl</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_bool</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">extras</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'use_ssl'</span><span class="p">,</span> <span class="s1">'False'</span><span class="p">))</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">sql_proxy_use_tcp</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_bool</span><span class="p">(</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">extras</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'sql_proxy_use_tcp'</span><span class="p">,</span> <span class="s1">'False'</span><span class="p">))</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">sql_proxy_version</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">extras</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'sql_proxy_version'</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">sql_proxy_binary_path</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">extras</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'sql_proxy_binary_path'</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">user</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">cloudsql_connection</span><span class="o">.</span><span class="n">login</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">password</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">cloudsql_connection</span><span class="o">.</span><span class="n">password</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">public_ip</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">cloudsql_connection</span><span class="o">.</span><span class="n">host</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">public_port</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">cloudsql_connection</span><span class="o">.</span><span class="n">port</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">sslcert</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">extras</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'sslcert'</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">sslkey</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">extras</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'sslkey'</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">sslrootcert</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">extras</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'sslrootcert'</span><span class="p">)</span> |
| <span class="c1"># Port and socket path and db_hook are automatically generated</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">sql_proxy_tcp_port</span> <span class="o">=</span> <span class="kc">None</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">sql_proxy_unique_path</span> <span class="o">=</span> <span class="kc">None</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">db_hook</span> <span class="o">=</span> <span class="kc">None</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">reserved_tcp_socket</span> <span class="o">=</span> <span class="kc">None</span> |
| <span class="c1"># Generated based on clock + clock sequence. Unique per host (!).</span> |
| <span class="c1"># This is important as different hosts share the database</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">db_conn_id</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">uuid</span><span class="o">.</span><span class="n">uuid1</span><span class="p">())</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_validate_inputs</span><span class="p">()</span> |
| |
| <span class="nd">@staticmethod</span> |
| <div class="viewcode-block" id="CloudSqlDatabaseHook._get_bool"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_sql_hook/index.html#airflow.contrib.hooks.gcp_sql_hook.CloudSqlDatabaseHook._get_bool">[docs]</a> <span class="k">def</span> <span class="nf">_get_bool</span><span class="p">(</span><span class="n">val</span><span class="p">):</span> |
| <span class="k">if</span> <span class="n">val</span> <span class="o">==</span> <span class="s1">'False'</span><span class="p">:</span> |
| <span class="k">return</span> <span class="kc">False</span> |
| <span class="k">return</span> <span class="n">val</span></div> |
| |
| <span class="nd">@staticmethod</span> |
| <div class="viewcode-block" id="CloudSqlDatabaseHook._check_ssl_file"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_sql_hook/index.html#airflow.contrib.hooks.gcp_sql_hook.CloudSqlDatabaseHook._check_ssl_file">[docs]</a> <span class="k">def</span> <span class="nf">_check_ssl_file</span><span class="p">(</span><span class="n">file_to_check</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="n">file_to_check</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s2">"SSL connections requires </span><span class="si">{name}</span><span class="s2"> to be set"</span><span class="o">.</span> |
| <span class="nb">format</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="n">name</span><span class="p">))</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">file_to_check</span><span class="p">):</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s2">"The </span><span class="si">{file_to_check}</span><span class="s2"> must be a readable file"</span><span class="o">.</span> |
| <span class="nb">format</span><span class="p">(</span><span class="n">file_to_check</span><span class="o">=</span><span class="n">file_to_check</span><span class="p">))</span></div> |
| |
| <div class="viewcode-block" id="CloudSqlDatabaseHook._validate_inputs"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_sql_hook/index.html#airflow.contrib.hooks.gcp_sql_hook.CloudSqlDatabaseHook._validate_inputs">[docs]</a> <span class="k">def</span> <span class="nf">_validate_inputs</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">project_id</span> <span class="o">==</span> <span class="s1">''</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s2">"The required extra 'project_id' is empty"</span><span class="p">)</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">location</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s2">"The required extra 'location' is empty or None"</span><span class="p">)</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">instance</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s2">"The required extra 'instance' is empty or None"</span><span class="p">)</span> |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">database_type</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">CLOUD_SQL_VALID_DATABASE_TYPES</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s2">"Invalid database type '</span><span class="si">{}</span><span class="s2">'. Must be one of </span><span class="si">{}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">database_type</span><span class="p">,</span> <span class="n">CLOUD_SQL_VALID_DATABASE_TYPES</span> |
| <span class="p">))</span> |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">use_proxy</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">use_ssl</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s2">"Cloud SQL Proxy does not support SSL connections."</span></div> |
| <span class="s2">" SSL is not needed as Cloud SQL Proxy "</span> |
| <span class="s2">"provides encryption on its own"</span><span class="p">)</span> |
| |
| <div class="viewcode-block" id="CloudSqlDatabaseHook.validate_ssl_certs"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_sql_hook/index.html#airflow.contrib.hooks.gcp_sql_hook.CloudSqlDatabaseHook.validate_ssl_certs">[docs]</a> <span class="k">def</span> <span class="nf">validate_ssl_certs</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">use_ssl</span><span class="p">:</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_check_ssl_file</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">sslcert</span><span class="p">,</span> <span class="s2">"sslcert"</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_check_ssl_file</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">sslkey</span><span class="p">,</span> <span class="s2">"sslkey"</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_check_ssl_file</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">sslrootcert</span><span class="p">,</span> <span class="s2">"sslrootcert"</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="CloudSqlDatabaseHook.validate_socket_path_length"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_sql_hook/index.html#airflow.contrib.hooks.gcp_sql_hook.CloudSqlDatabaseHook.validate_socket_path_length">[docs]</a> <span class="k">def</span> <span class="nf">validate_socket_path_length</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">use_proxy</span> <span class="ow">and</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">sql_proxy_use_tcp</span><span class="p">:</span> |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">database_type</span> <span class="o">==</span> <span class="s1">'postgres'</span><span class="p">:</span> |
| <span class="n">suffix</span> <span class="o">=</span> <span class="s2">"/.s.PGSQL.5432"</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="n">suffix</span> <span class="o">=</span> <span class="s2">""</span> |
| <span class="n">expected_path</span> <span class="o">=</span> <span class="s2">"</span><span class="si">{}</span><span class="s2">/</span><span class="si">{}</span><span class="s2">:</span><span class="si">{}</span><span class="s2">:</span><span class="si">{}{}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_generate_unique_path</span><span class="p">(),</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">project_id</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">instance</span><span class="p">,</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">database</span><span class="p">,</span> <span class="n">suffix</span><span class="p">)</span> |
| <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">expected_path</span><span class="p">)</span> <span class="o">></span> <span class="n">UNIX_PATH_MAX</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="s2">"Too long (</span><span class="si">%s</span><span class="s2">) path: </span><span class="si">%s</span><span class="s2">"</span><span class="p">,</span> <span class="nb">len</span><span class="p">(</span><span class="n">expected_path</span><span class="p">),</span> <span class="n">expected_path</span><span class="p">)</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span> |
| <span class="s2">"The UNIX socket path length cannot exceed </span><span class="si">{}</span><span class="s2"> characters "</span> |
| <span class="s2">"on Linux system. Either use shorter instance/database "</span> |
| <span class="s2">"name or switch to TCP connection. "</span> |
| <span class="s2">"The socket path for Cloud SQL proxy is now:"</span> |
| <span class="s2">"</span><span class="si">{}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span> |
| <span class="n">UNIX_PATH_MAX</span><span class="p">,</span> <span class="n">expected_path</span><span class="p">))</span></div> |
| |
| <span class="nd">@staticmethod</span> |
| <div class="viewcode-block" id="CloudSqlDatabaseHook._generate_unique_path"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_sql_hook/index.html#airflow.contrib.hooks.gcp_sql_hook.CloudSqlDatabaseHook._generate_unique_path">[docs]</a> <span class="k">def</span> <span class="nf">_generate_unique_path</span><span class="p">():</span> |
| <span class="c1"># We are not using mkdtemp here as the path generated with mkdtemp</span> |
| <span class="c1"># can be close to 60 characters and there is a limitation in</span> |
| <span class="c1"># length of socket path to around 100 characters in total.</span> |
| <span class="c1"># We append project/location/instance to it later and postgres</span> |
| <span class="c1"># appends its own prefix, so we chose a shorter "/tmp/[8 random characters]" -</span> |
| <span class="n">random</span><span class="o">.</span><span class="n">seed</span><span class="p">()</span> |
| <span class="k">while</span> <span class="kc">True</span><span class="p">:</span> |
| <span class="n">candidate</span> <span class="o">=</span> <span class="s2">"/tmp/"</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">random</span><span class="o">.</span><span class="n">choice</span><span class="p">(</span><span class="n">string</span><span class="o">.</span><span class="n">ascii_lowercase</span> <span class="o">+</span> <span class="n">string</span><span class="o">.</span><span class="n">digits</span><span class="p">)</span> <span class="k">for</span> <span class="n">_</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">8</span><span class="p">))</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">exists</span><span class="p">(</span><span class="n">candidate</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">candidate</span></div> |
| |
| <span class="nd">@staticmethod</span> |
| <div class="viewcode-block" id="CloudSqlDatabaseHook._quote"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_sql_hook/index.html#airflow.contrib.hooks.gcp_sql_hook.CloudSqlDatabaseHook._quote">[docs]</a> <span class="k">def</span> <span class="nf">_quote</span><span class="p">(</span><span class="n">value</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">quote_plus</span><span class="p">(</span><span class="n">value</span><span class="p">)</span> <span class="k">if</span> <span class="n">value</span> <span class="k">else</span> <span class="kc">None</span></div> |
| |
| <div class="viewcode-block" id="CloudSqlDatabaseHook._generate_connection_uri"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_sql_hook/index.html#airflow.contrib.hooks.gcp_sql_hook.CloudSqlDatabaseHook._generate_connection_uri">[docs]</a> <span class="k">def</span> <span class="nf">_generate_connection_uri</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">use_proxy</span><span class="p">:</span> |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">sql_proxy_use_tcp</span><span class="p">:</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">sql_proxy_tcp_port</span><span class="p">:</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">reserve_free_tcp_port</span><span class="p">()</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">sql_proxy_unique_path</span><span class="p">:</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">sql_proxy_unique_path</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_generate_unique_path</span><span class="p">()</span> |
| |
| <span class="n">database_uris</span> <span class="o">=</span> <span class="n">CONNECTION_URIS</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">database_type</span><span class="p">]</span> |
| <span class="n">ssl_spec</span> <span class="o">=</span> <span class="kc">None</span> |
| <span class="n">socket_path</span> <span class="o">=</span> <span class="kc">None</span> |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">use_proxy</span><span class="p">:</span> |
| <span class="n">proxy_uris</span> <span class="o">=</span> <span class="n">database_uris</span><span class="p">[</span><span class="s1">'proxy'</span><span class="p">]</span> |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">sql_proxy_use_tcp</span><span class="p">:</span> |
| <span class="n">format_string</span> <span class="o">=</span> <span class="n">proxy_uris</span><span class="p">[</span><span class="s1">'tcp'</span><span class="p">]</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="n">format_string</span> <span class="o">=</span> <span class="n">proxy_uris</span><span class="p">[</span><span class="s1">'socket'</span><span class="p">]</span> |
| <span class="n">socket_path</span> <span class="o">=</span> \ |
| <span class="s2">"</span><span class="si">{sql_proxy_socket_path}</span><span class="s2">/</span><span class="si">{instance_socket_name}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span> |
| <span class="n">sql_proxy_socket_path</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">sql_proxy_unique_path</span><span class="p">,</span> |
| <span class="n">instance_socket_name</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_get_instance_socket_name</span><span class="p">()</span> |
| <span class="p">)</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="n">public_uris</span> <span class="o">=</span> <span class="n">database_uris</span><span class="p">[</span><span class="s1">'public'</span><span class="p">]</span> |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">use_ssl</span><span class="p">:</span> |
| <span class="n">format_string</span> <span class="o">=</span> <span class="n">public_uris</span><span class="p">[</span><span class="s1">'ssl'</span><span class="p">]</span> |
| <span class="n">ssl_spec</span> <span class="o">=</span> <span class="p">{</span> |
| <span class="s1">'cert'</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">sslcert</span><span class="p">,</span> |
| <span class="s1">'key'</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">sslkey</span><span class="p">,</span> |
| <span class="s1">'ca'</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">sslrootcert</span> |
| <span class="p">}</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="n">format_string</span> <span class="o">=</span> <span class="n">public_uris</span><span class="p">[</span><span class="s1">'non-ssl'</span><span class="p">]</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">user</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s2">"The login parameter needs to be set in connection"</span><span class="p">)</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">public_ip</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s2">"The location parameter needs to be set in connection"</span><span class="p">)</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">password</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s2">"The password parameter needs to be set in connection"</span><span class="p">)</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">database</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s2">"The database parameter needs to be set in connection"</span><span class="p">)</span> |
| |
| <span class="n">connection_uri</span> <span class="o">=</span> <span class="n">format_string</span><span class="o">.</span><span class="n">format</span><span class="p">(</span> |
| <span class="n">user</span><span class="o">=</span><span class="n">quote_plus</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">user</span><span class="p">)</span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">user</span> <span class="k">else</span> <span class="s1">''</span><span class="p">,</span> |
| <span class="n">password</span><span class="o">=</span><span class="n">quote_plus</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">password</span><span class="p">)</span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">password</span> <span class="k">else</span> <span class="s1">''</span><span class="p">,</span> |
| <span class="n">database</span><span class="o">=</span><span class="n">quote_plus</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">database</span><span class="p">)</span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">database</span> <span class="k">else</span> <span class="s1">''</span><span class="p">,</span> |
| <span class="n">public_ip</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">public_ip</span><span class="p">,</span> |
| <span class="n">public_port</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">public_port</span><span class="p">,</span> |
| <span class="n">proxy_port</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">sql_proxy_tcp_port</span><span class="p">,</span> |
| <span class="n">socket_path</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_quote</span><span class="p">(</span><span class="n">socket_path</span><span class="p">),</span> |
| <span class="n">ssl_spec</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_quote</span><span class="p">(</span><span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">ssl_spec</span><span class="p">))</span> <span class="k">if</span> <span class="n">ssl_spec</span> <span class="k">else</span> <span class="s1">''</span><span class="p">,</span> |
| <span class="n">client_cert_file</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_quote</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">sslcert</span><span class="p">)</span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">sslcert</span> <span class="k">else</span> <span class="s1">''</span><span class="p">,</span> |
| <span class="n">client_key_file</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_quote</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">sslkey</span><span class="p">)</span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">sslcert</span> <span class="k">else</span> <span class="s1">''</span><span class="p">,</span> |
| <span class="n">server_ca_file</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_quote</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">sslrootcert</span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">sslcert</span> <span class="k">else</span> <span class="s1">''</span><span class="p">)</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="s2">"DB connection URI </span><span class="si">%s</span><span class="s2">"</span><span class="p">,</span> <span class="n">connection_uri</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span> |
| <span class="n">quote_plus</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">password</span><span class="p">)</span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">password</span> <span class="k">else</span> <span class="s1">'PASSWORD'</span><span class="p">,</span> <span class="s1">'XXXXXXXXXXXX'</span><span class="p">))</span> |
| <span class="k">return</span> <span class="n">connection_uri</span></div> |
| |
| <div class="viewcode-block" id="CloudSqlDatabaseHook._get_instance_socket_name"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_sql_hook/index.html#airflow.contrib.hooks.gcp_sql_hook.CloudSqlDatabaseHook._get_instance_socket_name">[docs]</a> <span class="k">def</span> <span class="nf">_get_instance_socket_name</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">project_id</span> <span class="o">+</span> <span class="s2">":"</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">location</span> <span class="o">+</span> <span class="s2">":"</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">instance</span></div> |
| |
| <div class="viewcode-block" id="CloudSqlDatabaseHook._get_sqlproxy_instance_specification"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_sql_hook/index.html#airflow.contrib.hooks.gcp_sql_hook.CloudSqlDatabaseHook._get_sqlproxy_instance_specification">[docs]</a> <span class="k">def</span> <span class="nf">_get_sqlproxy_instance_specification</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="n">instance_specification</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_instance_socket_name</span><span class="p">()</span> |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">sql_proxy_use_tcp</span><span class="p">:</span> |
| <span class="n">instance_specification</span> <span class="o">+=</span> <span class="s2">"=tcp:"</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">sql_proxy_tcp_port</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">instance_specification</span></div> |
| |
| <span class="nd">@provide_session</span> |
| <div class="viewcode-block" id="CloudSqlDatabaseHook.create_connection"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_sql_hook/index.html#airflow.contrib.hooks.gcp_sql_hook.CloudSqlDatabaseHook.create_connection">[docs]</a> <span class="k">def</span> <span class="nf">create_connection</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">session</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Create connection in the Connection table, according to whether it uses</span> |
| <span class="sd"> proxy, TCP, UNIX sockets, SSL. Connection ID will be randomly generated.</span> |
| |
| <span class="sd"> :param session: Session of the SQL Alchemy ORM (automatically generated with</span> |
| <span class="sd"> decorator).</span> |
| <span class="sd"> """</span> |
| <span class="n">connection</span> <span class="o">=</span> <span class="n">Connection</span><span class="p">(</span><span class="n">conn_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">db_conn_id</span><span class="p">)</span> |
| <span class="n">uri</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_generate_connection_uri</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="s2">"Creating connection </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">db_conn_id</span><span class="p">)</span> |
| <span class="n">connection</span><span class="o">.</span><span class="n">parse_from_uri</span><span class="p">(</span><span class="n">uri</span><span class="p">)</span> |
| <span class="n">session</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">connection</span><span class="p">)</span> |
| <span class="n">session</span><span class="o">.</span><span class="n">commit</span><span class="p">()</span></div> |
| |
| <span class="nd">@provide_session</span> |
| <div class="viewcode-block" id="CloudSqlDatabaseHook.retrieve_connection"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_sql_hook/index.html#airflow.contrib.hooks.gcp_sql_hook.CloudSqlDatabaseHook.retrieve_connection">[docs]</a> <span class="k">def</span> <span class="nf">retrieve_connection</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">session</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Retrieves the dynamically created connection from the Connection table.</span> |
| |
| <span class="sd"> :param session: Session of the SQL Alchemy ORM (automatically generated with</span> |
| <span class="sd"> decorator).</span> |
| <span class="sd"> """</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="s2">"Retrieving connection </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">db_conn_id</span><span class="p">)</span> |
| <span class="n">connections</span> <span class="o">=</span> <span class="n">session</span><span class="o">.</span><span class="n">query</span><span class="p">(</span><span class="n">Connection</span><span class="p">)</span><span class="o">.</span><span class="n">filter</span><span class="p">(</span> |
| <span class="n">Connection</span><span class="o">.</span><span class="n">conn_id</span> <span class="o">==</span> <span class="bp">self</span><span class="o">.</span><span class="n">db_conn_id</span><span class="p">)</span> |
| <span class="k">if</span> <span class="n">connections</span><span class="o">.</span><span class="n">count</span><span class="p">():</span> |
| <span class="k">return</span> <span class="n">connections</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> |
| <span class="k">return</span> <span class="kc">None</span></div> |
| |
| <span class="nd">@provide_session</span> |
| <div class="viewcode-block" id="CloudSqlDatabaseHook.delete_connection"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_sql_hook/index.html#airflow.contrib.hooks.gcp_sql_hook.CloudSqlDatabaseHook.delete_connection">[docs]</a> <span class="k">def</span> <span class="nf">delete_connection</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">session</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Delete the dynamically created connection from the Connection table.</span> |
| |
| <span class="sd"> :param session: Session of the SQL Alchemy ORM (automatically generated with</span> |
| <span class="sd"> decorator).</span> |
| <span class="sd"> """</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="s2">"Deleting connection </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">db_conn_id</span><span class="p">)</span> |
| |
| <span class="n">connections</span> <span class="o">=</span> <span class="n">session</span><span class="o">.</span><span class="n">query</span><span class="p">(</span><span class="n">Connection</span><span class="p">)</span><span class="o">.</span><span class="n">filter</span><span class="p">(</span> |
| <span class="n">Connection</span><span class="o">.</span><span class="n">conn_id</span> <span class="o">==</span> <span class="bp">self</span><span class="o">.</span><span class="n">db_conn_id</span><span class="p">)</span> |
| <span class="k">if</span> <span class="n">connections</span><span class="o">.</span><span class="n">count</span><span class="p">():</span> |
| <span class="n">connection</span> <span class="o">=</span> <span class="n">connections</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> |
| <span class="n">session</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="n">connection</span><span class="p">)</span> |
| <span class="n">session</span><span class="o">.</span><span class="n">commit</span><span class="p">()</span> |
| <span class="k">else</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="s2">"Connection was already deleted!"</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="CloudSqlDatabaseHook.get_sqlproxy_runner"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_sql_hook/index.html#airflow.contrib.hooks.gcp_sql_hook.CloudSqlDatabaseHook.get_sqlproxy_runner">[docs]</a> <span class="k">def</span> <span class="nf">get_sqlproxy_runner</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Retrieve Cloud SQL Proxy runner. It is used to manage the proxy</span> |
| <span class="sd"> lifecycle per task.</span> |
| |
| <span class="sd"> :return: The Cloud SQL Proxy runner.</span> |
| <span class="sd"> :rtype: CloudSqlProxyRunner</span> |
| <span class="sd"> """</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">use_proxy</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s2">"Proxy runner can only be retrieved in case of use_proxy = True"</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">CloudSqlProxyRunner</span><span class="p">(</span> |
| <span class="n">path_prefix</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">sql_proxy_unique_path</span><span class="p">,</span> |
| <span class="n">instance_specification</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_get_sqlproxy_instance_specification</span><span class="p">(),</span> |
| <span class="n">project_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">project_id</span><span class="p">,</span> |
| <span class="n">sql_proxy_version</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">sql_proxy_version</span><span class="p">,</span> |
| <span class="n">sql_proxy_binary_path</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">sql_proxy_binary_path</span><span class="p">,</span> |
| <span class="n">gcp_conn_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">gcp_conn_id</span></div> |
| <span class="p">)</span> |
| |
| <div class="viewcode-block" id="CloudSqlDatabaseHook.get_database_hook"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_sql_hook/index.html#airflow.contrib.hooks.gcp_sql_hook.CloudSqlDatabaseHook.get_database_hook">[docs]</a> <span class="k">def</span> <span class="nf">get_database_hook</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Retrieve database hook. This is the actual Postgres or MySQL database hook</span> |
| <span class="sd"> that uses proxy or connects directly to the Google Cloud SQL database.</span> |
| <span class="sd"> """</span> |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">database_type</span> <span class="o">==</span> <span class="s1">'postgres'</span><span class="p">:</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">db_hook</span> <span class="o">=</span> <span class="n">PostgresHook</span><span class="p">(</span><span class="n">postgres_conn_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">db_conn_id</span><span class="p">,</span> |
| <span class="n">schema</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">database</span><span class="p">)</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">db_hook</span> <span class="o">=</span> <span class="n">MySqlHook</span><span class="p">(</span><span class="n">mysql_conn_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">db_conn_id</span><span class="p">,</span> |
| <span class="n">schema</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">database</span><span class="p">)</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">db_hook</span></div> |
| |
| <div class="viewcode-block" id="CloudSqlDatabaseHook.cleanup_database_hook"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_sql_hook/index.html#airflow.contrib.hooks.gcp_sql_hook.CloudSqlDatabaseHook.cleanup_database_hook">[docs]</a> <span class="k">def</span> <span class="nf">cleanup_database_hook</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Clean up database hook after it was used.</span> |
| <span class="sd"> """</span> |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">database_type</span> <span class="o">==</span> <span class="s1">'postgres'</span><span class="p">:</span> |
| <span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">db_hook</span><span class="p">,</span> |
| <span class="s1">'conn'</span><span class="p">)</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">db_hook</span><span class="o">.</span><span class="n">conn</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">db_hook</span><span class="o">.</span><span class="n">conn</span><span class="o">.</span><span class="n">notices</span><span class="p">:</span> |
| <span class="k">for</span> <span class="n">output</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">db_hook</span><span class="o">.</span><span class="n">conn</span><span class="o">.</span><span class="n">notices</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="n">output</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="CloudSqlDatabaseHook.reserve_free_tcp_port"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_sql_hook/index.html#airflow.contrib.hooks.gcp_sql_hook.CloudSqlDatabaseHook.reserve_free_tcp_port">[docs]</a> <span class="k">def</span> <span class="nf">reserve_free_tcp_port</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Reserve free TCP port to be used by Cloud SQL Proxy</span> |
| <span class="sd"> """</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">reserved_tcp_socket</span> <span class="o">=</span> <span class="n">socket</span><span class="o">.</span><span class="n">socket</span><span class="p">(</span><span class="n">socket</span><span class="o">.</span><span class="n">AF_INET</span><span class="p">,</span> <span class="n">socket</span><span class="o">.</span><span class="n">SOCK_STREAM</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">reserved_tcp_socket</span><span class="o">.</span><span class="n">bind</span><span class="p">((</span><span class="s1">'127.0.0.1'</span><span class="p">,</span> <span class="mi">0</span><span class="p">))</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">sql_proxy_tcp_port</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">reserved_tcp_socket</span><span class="o">.</span><span class="n">getsockname</span><span class="p">()[</span><span class="mi">1</span><span class="p">]</span></div> |
| |
| <div class="viewcode-block" id="CloudSqlDatabaseHook.free_reserved_port"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_sql_hook/index.html#airflow.contrib.hooks.gcp_sql_hook.CloudSqlDatabaseHook.free_reserved_port">[docs]</a> <span class="k">def</span> <span class="nf">free_reserved_port</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Free TCP port. Makes it immediately ready to be used by Cloud SQL Proxy.</span> |
| <span class="sd"> """</span> |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">reserved_tcp_socket</span><span class="p">:</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">reserved_tcp_socket</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">reserved_tcp_socket</span> <span class="o">=</span> <span class="kc">None</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> |
