Google Git
Sign in
apache / airflow-site / f81e48aadee354653679693fa54b04ac42d24bfd / . / docs-archive / 1.10.5 / _modules / airflow / contrib / example_dags / example_gcp_sql_query.html
blob: 94e7af7d6fa5843ab755ce76a388225e7153850f [file] [log] [blame]
<!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.example_dags.example_gcp_sql_query &mdash; Airflow Documentation</title>
<script type="text/javascript" src="../../../../_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../../../../" src="../../../../_static/documentation_options.js"></script>
<script type="text/javascript" src="../../../../_static/jquery.js"></script>
<script type="text/javascript" src="../../../../_static/underscore.js"></script>
<script type="text/javascript" src="../../../../_static/doctools.js"></script>
<script type="text/javascript" src="../../../../_static/language_data.js"></script>
<script type="text/javascript" src="../../../../_static/js/theme.js"></script>
<link rel="stylesheet" href="../../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="../../../../genindex.html" />
<link rel="search" title="Search" href="../../../../search.html" />
<script>
document.addEventListener('DOMContentLoaded', function() {
var el = document.getElementById('changelog');
if (el !== null ) {
// [AIRFLOW-...]
el.innerHTML = el.innerHTML.replace(
/\[(AIRFLOW-[\d]+)\]/g,
`<a href="https://issues.apache.org/jira/browse/$1">[$1]</a>`
);
// (#...)
el.innerHTML = el.innerHTML.replace(
/\(#([\d]+)\)/g,
`<a href="https://github.com/apache/airflow/pull/$1">(#$1)</a>`
);
};
})
</script>
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-140539454-1']);
_gaq.push(['_trackPageview']);
</script>
<style>
.example-header {
position: relative;
background: #9AAA7A;
padding: 8px 16px;
margin-bottom: 0;
}
.example-header--with-button {
padding-right: 166px;
}
.example-header:after{
content: '';
display: table;
clear: both;
}
.example-title {
display:block;
padding: 4px;
margin-right: 16px;
color: white;
overflow-x: auto;
}
.example-header-button {
top: 8px;
right: 16px;
position: absolute;
}
.example-header + .highlight-python {
margin-top: 0 !important;
}
.viewcode-button {
display: inline-block;
padding: 8px 16px;
border: 0;
margin: 0;
outline: 0;
border-radius: 2px;
-webkit-box-shadow: 0 3px 5px 0 rgba(0,0,0,.3);
box-shadow: 0 3px 6px 0 rgba(0,0,0,.3);
color: #404040;
background-color: #e7e7e7;
cursor: pointer;
font-size: 16px;
font-weight: 500;
line-height: 1;
text-decoration: none;
text-overflow: ellipsis;
overflow: hidden;
text-transform: uppercase;
-webkit-transition: background-color .2s;
transition: background-color .2s;
vertical-align: middle;
white-space: nowrap;
}
.viewcode-button:visited {
color: #404040;
}
.viewcode-button:hover, .viewcode-button:focus {
color: #404040;
background-color: #d6d6d6;
}
</style>
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../../../../index.html" class="icon icon-home"> Airflow
</a>
<div class="version">
1.10.5
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../../project.html">Project</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../license.html">License</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../start.html">Quick Start</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../tutorial.html">Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../howto/index.html">How-to Guides</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../ui.html">UI / Screenshots</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../concepts.html">Concepts</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../profiling.html">Data Profiling</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../cli.html">Command Line Interface Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../scheduler.html">Scheduling &amp; Triggers</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../plugins.html">Plugins</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../security.html">Security</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../timezone.html">Time zones</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../api.html">REST API Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../integration.html">Integration</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../metrics.html">Metrics</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../kubernetes.html">Kubernetes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../lineage.html">Lineage</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../changelog.html">Changelog</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../faq.html">FAQ</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../macros.html">Macros reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../_api/index.html">Python API Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../privacy_notice.html">Privacy Notice</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../../../index.html">Airflow</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../../../index.html">Docs</a> &raquo;</li>
<li><a href="../../../index.html">Module code</a> &raquo;</li>
<li>airflow.contrib.example_dags.example_gcp_sql_query</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.example_dags.example_gcp_sql_query</h1><div class="highlight"><pre>
<span></span><span class="c1"># -*- coding: utf-8 -*-</span>
<span class="c1">#</span>
<span class="c1"># Licensed to the Apache Software Foundation (ASF) under one</span>
<span class="c1"># or more contributor license agreements. See the NOTICE file</span>
<span class="c1"># distributed with this work for additional information</span>
<span class="c1"># regarding copyright ownership. The ASF licenses this file</span>
<span class="c1"># to you under the Apache License, Version 2.0 (the</span>
<span class="c1"># &quot;License&quot;); you may not use this file except in compliance</span>
<span class="c1"># with the License. You may obtain a copy of the License at</span>
<span class="c1">#</span>
<span class="c1"># http://www.apache.org/licenses/LICENSE-2.0</span>
<span class="c1">#</span>
<span class="c1"># Unless required by applicable law or agreed to in writing,</span>
<span class="c1"># software distributed under the License is distributed on an</span>
<span class="c1"># &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span>
<span class="c1"># KIND, either express or implied. See the License for the</span>
<span class="c1"># specific language governing permissions and limitations</span>
<span class="c1"># under the License.</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd">Example Airflow DAG that performs query in a Cloud SQL instance.</span>
<span class="sd">This DAG relies on the following OS environment variables</span>
<span class="sd">* GCP_PROJECT_ID - Google Cloud Platform project for the Cloud SQL instance</span>
<span class="sd">* GCP_REGION - Google Cloud region where the database is created</span>
<span class="sd">*</span>
<span class="sd">* GCSQL_POSTGRES_INSTANCE_NAME - Name of the postgres Cloud SQL instance</span>
<span class="sd">* GCSQL_POSTGRES_USER - Name of the postgres database user</span>
<span class="sd">* GCSQL_POSTGRES_PASSWORD - Password of the postgres database user</span>
<span class="sd">* GCSQL_POSTGRES_PUBLIC_IP - Public IP of the Postgres database</span>
<span class="sd">* GCSQL_POSTGRES_PUBLIC_PORT - Port of the postgres database</span>
<span class="sd">*</span>
<span class="sd">* GCSQL_MYSQL_INSTANCE_NAME - Name of the postgres Cloud SQL instance</span>
<span class="sd">* GCSQL_MYSQL_USER - Name of the mysql database user</span>
<span class="sd">* GCSQL_MYSQL_PASSWORD - Password of the mysql database user</span>
<span class="sd">* GCSQL_MYSQL_PUBLIC_IP - Public IP of the mysql database</span>
<span class="sd">* GCSQL_MYSQL_PUBLIC_PORT - Port of the mysql database</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="kn">import</span> <span class="nn">os</span>
<span class="kn">import</span> <span class="nn">subprocess</span>
<span class="kn">from</span> <span class="nn">os.path</span> <span class="k">import</span> <span class="n">expanduser</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">airflow</span>
<span class="kn">from</span> <span class="nn">airflow</span> <span class="k">import</span> <span class="n">models</span>
<span class="kn">from</span> <span class="nn">airflow.contrib.operators.gcp_sql_operator</span> <span class="k">import</span> <span class="n">CloudSqlQueryOperator</span>
<span class="c1"># [START howto_operator_cloudsql_query_arguments]</span>
<span class="n">GCP_PROJECT_ID</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;GCP_PROJECT_ID&#39;</span><span class="p">,</span> <span class="s1">&#39;example-project&#39;</span><span class="p">)</span>
<span class="n">GCP_REGION</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;GCP_REGION&#39;</span><span class="p">,</span> <span class="s1">&#39;europe-west-1b&#39;</span><span class="p">)</span>
<span class="n">GCSQL_POSTGRES_INSTANCE_NAME_QUERY</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span>
<span class="s1">&#39;GCSQL_POSTGRES_INSTANCE_NAME_QUERY&#39;</span><span class="p">,</span>
<span class="s1">&#39;testpostgres&#39;</span><span class="p">)</span>
<span class="n">GCSQL_POSTGRES_DATABASE_NAME</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;GCSQL_POSTGRES_DATABASE_NAME&#39;</span><span class="p">,</span>
<span class="s1">&#39;postgresdb&#39;</span><span class="p">)</span>
<span class="n">GCSQL_POSTGRES_USER</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;GCSQL_POSTGRES_USER&#39;</span><span class="p">,</span> <span class="s1">&#39;postgres_user&#39;</span><span class="p">)</span>
<span class="n">GCSQL_POSTGRES_PASSWORD</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;GCSQL_POSTGRES_PASSWORD&#39;</span><span class="p">,</span> <span class="s1">&#39;password&#39;</span><span class="p">)</span>
<span class="n">GCSQL_POSTGRES_PUBLIC_IP</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;GCSQL_POSTGRES_PUBLIC_IP&#39;</span><span class="p">,</span> <span class="s1">&#39;0.0.0.0&#39;</span><span class="p">)</span>
<span class="n">GCSQL_POSTGRES_PUBLIC_PORT</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;GCSQL_POSTGRES_PUBLIC_PORT&#39;</span><span class="p">,</span> <span class="mi">5432</span><span class="p">)</span>
<span class="n">GCSQL_POSTGRES_CLIENT_CERT_FILE</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;GCSQL_POSTGRES_CLIENT_CERT_FILE&#39;</span><span class="p">,</span>
<span class="s2">&quot;.key/postgres-client-cert.pem&quot;</span><span class="p">)</span>
<span class="n">GCSQL_POSTGRES_CLIENT_KEY_FILE</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;GCSQL_POSTGRES_CLIENT_KEY_FILE&#39;</span><span class="p">,</span>
<span class="s2">&quot;.key/postgres-client-key.pem&quot;</span><span class="p">)</span>
<span class="n">GCSQL_POSTGRES_SERVER_CA_FILE</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;GCSQL_POSTGRES_SERVER_CA_FILE&#39;</span><span class="p">,</span>
<span class="s2">&quot;.key/postgres-server-ca.pem&quot;</span><span class="p">)</span>
<span class="n">GCSQL_MYSQL_INSTANCE_NAME_QUERY</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;GCSQL_MYSQL_INSTANCE_NAME_QUERY&#39;</span><span class="p">,</span>
<span class="s1">&#39;testmysql&#39;</span><span class="p">)</span>
<span class="n">GCSQL_MYSQL_DATABASE_NAME</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;GCSQL_MYSQL_DATABASE_NAME&#39;</span><span class="p">,</span> <span class="s1">&#39;mysqldb&#39;</span><span class="p">)</span>
<span class="n">GCSQL_MYSQL_USER</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;GCSQL_MYSQL_USER&#39;</span><span class="p">,</span> <span class="s1">&#39;mysql_user&#39;</span><span class="p">)</span>
<span class="n">GCSQL_MYSQL_PASSWORD</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;GCSQL_MYSQL_PASSWORD&#39;</span><span class="p">,</span> <span class="s1">&#39;password&#39;</span><span class="p">)</span>
<span class="n">GCSQL_MYSQL_PUBLIC_IP</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;GCSQL_MYSQL_PUBLIC_IP&#39;</span><span class="p">,</span> <span class="s1">&#39;0.0.0.0&#39;</span><span class="p">)</span>
<span class="n">GCSQL_MYSQL_PUBLIC_PORT</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;GCSQL_MYSQL_PUBLIC_PORT&#39;</span><span class="p">,</span> <span class="mi">3306</span><span class="p">)</span>
<span class="n">GCSQL_MYSQL_CLIENT_CERT_FILE</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;GCSQL_MYSQL_CLIENT_CERT_FILE&#39;</span><span class="p">,</span>
<span class="s2">&quot;.key/mysql-client-cert.pem&quot;</span><span class="p">)</span>
<span class="n">GCSQL_MYSQL_CLIENT_KEY_FILE</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;GCSQL_MYSQL_CLIENT_KEY_FILE&#39;</span><span class="p">,</span>
<span class="s2">&quot;.key/mysql-client-key.pem&quot;</span><span class="p">)</span>
<span class="n">GCSQL_MYSQL_SERVER_CA_FILE</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;GCSQL_MYSQL_SERVER_CA_FILE&#39;</span><span class="p">,</span>
<span class="s2">&quot;.key/mysql-server-ca.pem&quot;</span><span class="p">)</span>
<span class="n">SQL</span> <span class="o">=</span> <span class="p">[</span>
<span class="s1">&#39;CREATE TABLE IF NOT EXISTS TABLE_TEST (I INTEGER)&#39;</span><span class="p">,</span>
<span class="s1">&#39;CREATE TABLE IF NOT EXISTS TABLE_TEST (I INTEGER)&#39;</span><span class="p">,</span> <span class="c1"># shows warnings logged</span>
<span class="s1">&#39;INSERT INTO TABLE_TEST VALUES (0)&#39;</span><span class="p">,</span>
<span class="s1">&#39;CREATE TABLE IF NOT EXISTS TABLE_TEST2 (I INTEGER)&#39;</span><span class="p">,</span>
<span class="s1">&#39;DROP TABLE TABLE_TEST&#39;</span><span class="p">,</span>
<span class="s1">&#39;DROP TABLE TABLE_TEST2&#39;</span><span class="p">,</span>
<span class="p">]</span>
<span class="c1"># [END howto_operator_cloudsql_query_arguments]</span>
<span class="n">default_args</span> <span class="o">=</span> <span class="p">{</span>
<span class="s1">&#39;start_date&#39;</span><span class="p">:</span> <span class="n">airflow</span><span class="o">.</span><span class="n">utils</span><span class="o">.</span><span class="n">dates</span><span class="o">.</span><span class="n">days_ago</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>
<span class="p">}</span>
<span class="c1"># [START howto_operator_cloudsql_query_connections]</span>
<span class="n">HOME_DIR</span> <span class="o">=</span> <span class="n">expanduser</span><span class="p">(</span><span class="s2">&quot;~&quot;</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">get_absolute_path</span><span class="p">(</span><span class="n">path</span><span class="p">):</span>
<span class="k">if</span> <span class="n">path</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s2">&quot;/&quot;</span><span class="p">):</span>
<span class="k">return</span> <span class="n">path</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">HOME_DIR</span><span class="p">,</span> <span class="n">path</span><span class="p">)</span>
<span class="n">postgres_kwargs</span> <span class="o">=</span> <span class="nb">dict</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="n">GCSQL_POSTGRES_USER</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="n">GCSQL_POSTGRES_PASSWORD</span><span class="p">),</span>
<span class="n">public_port</span><span class="o">=</span><span class="n">GCSQL_POSTGRES_PUBLIC_PORT</span><span class="p">,</span>
<span class="n">public_ip</span><span class="o">=</span><span class="n">quote_plus</span><span class="p">(</span><span class="n">GCSQL_POSTGRES_PUBLIC_IP</span><span class="p">),</span>
<span class="n">project_id</span><span class="o">=</span><span class="n">quote_plus</span><span class="p">(</span><span class="n">GCP_PROJECT_ID</span><span class="p">),</span>
<span class="n">location</span><span class="o">=</span><span class="n">quote_plus</span><span class="p">(</span><span class="n">GCP_REGION</span><span class="p">),</span>
<span class="n">instance</span><span class="o">=</span><span class="n">quote_plus</span><span class="p">(</span><span class="n">GCSQL_POSTGRES_INSTANCE_NAME_QUERY</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="n">GCSQL_POSTGRES_DATABASE_NAME</span><span class="p">),</span>
<span class="n">client_cert_file</span><span class="o">=</span><span class="n">quote_plus</span><span class="p">(</span><span class="n">get_absolute_path</span><span class="p">(</span><span class="n">GCSQL_POSTGRES_CLIENT_CERT_FILE</span><span class="p">)),</span>
<span class="n">client_key_file</span><span class="o">=</span><span class="n">quote_plus</span><span class="p">(</span><span class="n">get_absolute_path</span><span class="p">(</span><span class="n">GCSQL_POSTGRES_CLIENT_KEY_FILE</span><span class="p">)),</span>
<span class="n">server_ca_file</span><span class="o">=</span><span class="n">quote_plus</span><span class="p">(</span><span class="n">get_absolute_path</span><span class="p">(</span><span class="n">GCSQL_POSTGRES_SERVER_CA_FILE</span><span class="p">))</span>
<span class="p">)</span>
<span class="c1"># The connections below are created using one of the standard approaches - via environment</span>
<span class="c1"># variables named AIRFLOW_CONN_* . The connections can also be created in the database</span>
<span class="c1"># of AIRFLOW (using command line or UI).</span>
<span class="c1"># Postgres: connect via proxy over TCP</span>
<span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s1">&#39;AIRFLOW_CONN_PROXY_POSTGRES_TCP&#39;</span><span class="p">]</span> <span class="o">=</span> \
<span class="s2">&quot;gcpcloudsql://</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">?&quot;</span> \
<span class="s2">&quot;database_type=postgres&amp;&quot;</span> \
<span class="s2">&quot;project_id=</span><span class="si">{project_id}</span><span class="s2">&amp;&quot;</span> \
<span class="s2">&quot;location=</span><span class="si">{location}</span><span class="s2">&amp;&quot;</span> \
<span class="s2">&quot;instance=</span><span class="si">{instance}</span><span class="s2">&amp;&quot;</span> \
<span class="s2">&quot;use_proxy=True&amp;&quot;</span> \
<span class="s2">&quot;sql_proxy_use_tcp=True&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="o">**</span><span class="n">postgres_kwargs</span><span class="p">)</span>
<span class="c1"># Postgres: connect via proxy over UNIX socket (specific proxy version)</span>
<span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s1">&#39;AIRFLOW_CONN_PROXY_POSTGRES_SOCKET&#39;</span><span class="p">]</span> <span class="o">=</span> \
<span class="s2">&quot;gcpcloudsql://</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">?&quot;</span> \
<span class="s2">&quot;database_type=postgres&amp;&quot;</span> \
<span class="s2">&quot;project_id=</span><span class="si">{project_id}</span><span class="s2">&amp;&quot;</span> \
<span class="s2">&quot;location=</span><span class="si">{location}</span><span class="s2">&amp;&quot;</span> \
<span class="s2">&quot;instance=</span><span class="si">{instance}</span><span class="s2">&amp;&quot;</span> \
<span class="s2">&quot;use_proxy=True&amp;&quot;</span> \
<span class="s2">&quot;sql_proxy_version=v1.13&amp;&quot;</span> \
<span class="s2">&quot;sql_proxy_use_tcp=False&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="o">**</span><span class="n">postgres_kwargs</span><span class="p">)</span>
<span class="c1"># Postgres: connect directly via TCP (non-SSL)</span>
<span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s1">&#39;AIRFLOW_CONN_PUBLIC_POSTGRES_TCP&#39;</span><span class="p">]</span> <span class="o">=</span> \
<span class="s2">&quot;gcpcloudsql://</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">?&quot;</span> \
<span class="s2">&quot;database_type=postgres&amp;&quot;</span> \
<span class="s2">&quot;project_id=</span><span class="si">{project_id}</span><span class="s2">&amp;&quot;</span> \
<span class="s2">&quot;location=</span><span class="si">{location}</span><span class="s2">&amp;&quot;</span> \
<span class="s2">&quot;instance=</span><span class="si">{instance}</span><span class="s2">&amp;&quot;</span> \
<span class="s2">&quot;use_proxy=False&amp;&quot;</span> \
<span class="s2">&quot;use_ssl=False&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="o">**</span><span class="n">postgres_kwargs</span><span class="p">)</span>
<span class="c1"># Postgres: connect directly via TCP (SSL)</span>
<span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s1">&#39;AIRFLOW_CONN_PUBLIC_POSTGRES_TCP_SSL&#39;</span><span class="p">]</span> <span class="o">=</span> \
<span class="s2">&quot;gcpcloudsql://</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">?&quot;</span> \
<span class="s2">&quot;database_type=postgres&amp;&quot;</span> \
<span class="s2">&quot;project_id=</span><span class="si">{project_id}</span><span class="s2">&amp;&quot;</span> \
<span class="s2">&quot;location=</span><span class="si">{location}</span><span class="s2">&amp;&quot;</span> \
<span class="s2">&quot;instance=</span><span class="si">{instance}</span><span class="s2">&amp;&quot;</span> \
<span class="s2">&quot;use_proxy=False&amp;&quot;</span> \
<span class="s2">&quot;use_ssl=True&amp;&quot;</span> \
<span class="s2">&quot;sslcert=</span><span class="si">{client_cert_file}</span><span class="s2">&amp;&quot;</span> \
<span class="s2">&quot;sslkey=</span><span class="si">{client_key_file}</span><span class="s2">&amp;&quot;</span> \
<span class="s2">&quot;sslrootcert=</span><span class="si">{server_ca_file}</span><span class="s2">&quot;</span>\
<span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="o">**</span><span class="n">postgres_kwargs</span><span class="p">)</span>
<span class="n">mysql_kwargs</span> <span class="o">=</span> <span class="nb">dict</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="n">GCSQL_MYSQL_USER</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="n">GCSQL_MYSQL_PASSWORD</span><span class="p">),</span>
<span class="n">public_port</span><span class="o">=</span><span class="n">GCSQL_MYSQL_PUBLIC_PORT</span><span class="p">,</span>
<span class="n">public_ip</span><span class="o">=</span><span class="n">quote_plus</span><span class="p">(</span><span class="n">GCSQL_MYSQL_PUBLIC_IP</span><span class="p">),</span>
<span class="n">project_id</span><span class="o">=</span><span class="n">quote_plus</span><span class="p">(</span><span class="n">GCP_PROJECT_ID</span><span class="p">),</span>
<span class="n">location</span><span class="o">=</span><span class="n">quote_plus</span><span class="p">(</span><span class="n">GCP_REGION</span><span class="p">),</span>
<span class="n">instance</span><span class="o">=</span><span class="n">quote_plus</span><span class="p">(</span><span class="n">GCSQL_MYSQL_INSTANCE_NAME_QUERY</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="n">GCSQL_MYSQL_DATABASE_NAME</span><span class="p">),</span>
<span class="n">client_cert_file</span><span class="o">=</span><span class="n">quote_plus</span><span class="p">(</span><span class="n">get_absolute_path</span><span class="p">(</span><span class="n">GCSQL_MYSQL_CLIENT_CERT_FILE</span><span class="p">)),</span>
<span class="n">client_key_file</span><span class="o">=</span><span class="n">quote_plus</span><span class="p">(</span><span class="n">get_absolute_path</span><span class="p">(</span><span class="n">GCSQL_MYSQL_CLIENT_KEY_FILE</span><span class="p">)),</span>
<span class="n">server_ca_file</span><span class="o">=</span><span class="n">quote_plus</span><span class="p">(</span><span class="n">get_absolute_path</span><span class="p">(</span><span class="n">GCSQL_MYSQL_SERVER_CA_FILE</span><span class="p">))</span>
<span class="p">)</span>
<span class="c1"># MySQL: connect via proxy over TCP (specific proxy version)</span>
<span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s1">&#39;AIRFLOW_CONN_PROXY_MYSQL_TCP&#39;</span><span class="p">]</span> <span class="o">=</span> \
<span class="s2">&quot;gcpcloudsql://</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">?&quot;</span> \
<span class="s2">&quot;database_type=mysql&amp;&quot;</span> \
<span class="s2">&quot;project_id=</span><span class="si">{project_id}</span><span class="s2">&amp;&quot;</span> \
<span class="s2">&quot;location=</span><span class="si">{location}</span><span class="s2">&amp;&quot;</span> \
<span class="s2">&quot;instance=</span><span class="si">{instance}</span><span class="s2">&amp;&quot;</span> \
<span class="s2">&quot;use_proxy=True&amp;&quot;</span> \
<span class="s2">&quot;sql_proxy_version=v1.13&amp;&quot;</span> \
<span class="s2">&quot;sql_proxy_use_tcp=True&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="o">**</span><span class="n">mysql_kwargs</span><span class="p">)</span>
<span class="c1"># MySQL: connect via proxy over UNIX socket using pre-downloaded Cloud Sql Proxy binary</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">sql_proxy_binary_path</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="p">[</span><span class="s1">&#39;which&#39;</span><span class="p">,</span> <span class="s1">&#39;cloud_sql_proxy&#39;</span><span class="p">])</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s1">&#39;utf-8&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">rstrip</span><span class="p">()</span>
<span class="k">except</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">CalledProcessError</span><span class="p">:</span>
<span class="n">sql_proxy_binary_path</span> <span class="o">=</span> <span class="s2">&quot;/tmp/anyhow_download_cloud_sql_proxy&quot;</span>
<span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s1">&#39;AIRFLOW_CONN_PROXY_MYSQL_SOCKET&#39;</span><span class="p">]</span> <span class="o">=</span> \
<span class="s2">&quot;gcpcloudsql://</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">?&quot;</span> \
<span class="s2">&quot;database_type=mysql&amp;&quot;</span> \
<span class="s2">&quot;project_id=</span><span class="si">{project_id}</span><span class="s2">&amp;&quot;</span> \
<span class="s2">&quot;location=</span><span class="si">{location}</span><span class="s2">&amp;&quot;</span> \
<span class="s2">&quot;instance=</span><span class="si">{instance}</span><span class="s2">&amp;&quot;</span> \
<span class="s2">&quot;use_proxy=True&amp;&quot;</span> \
<span class="s2">&quot;sql_proxy_binary_path=</span><span class="si">{sql_proxy_binary_path}</span><span class="s2">&amp;&quot;</span> \
<span class="s2">&quot;sql_proxy_use_tcp=False&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
<span class="n">sql_proxy_binary_path</span><span class="o">=</span><span class="n">quote_plus</span><span class="p">(</span><span class="n">sql_proxy_binary_path</span><span class="p">),</span> <span class="o">**</span><span class="n">mysql_kwargs</span><span class="p">)</span>
<span class="c1"># MySQL: connect directly via TCP (non-SSL)</span>
<span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s1">&#39;AIRFLOW_CONN_PUBLIC_MYSQL_TCP&#39;</span><span class="p">]</span> <span class="o">=</span> \
<span class="s2">&quot;gcpcloudsql://</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">?&quot;</span> \
<span class="s2">&quot;database_type=mysql&amp;&quot;</span> \
<span class="s2">&quot;project_id=</span><span class="si">{project_id}</span><span class="s2">&amp;&quot;</span> \
<span class="s2">&quot;location=</span><span class="si">{location}</span><span class="s2">&amp;&quot;</span> \
<span class="s2">&quot;instance=</span><span class="si">{instance}</span><span class="s2">&amp;&quot;</span> \
<span class="s2">&quot;use_proxy=False&amp;&quot;</span> \
<span class="s2">&quot;use_ssl=False&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="o">**</span><span class="n">mysql_kwargs</span><span class="p">)</span>
<span class="c1"># MySQL: connect directly via TCP (SSL) and with fixed Cloud Sql Proxy binary path</span>
<span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s1">&#39;AIRFLOW_CONN_PUBLIC_MYSQL_TCP_SSL&#39;</span><span class="p">]</span> <span class="o">=</span> \
<span class="s2">&quot;gcpcloudsql://</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">?&quot;</span> \
<span class="s2">&quot;database_type=mysql&amp;&quot;</span> \
<span class="s2">&quot;project_id=</span><span class="si">{project_id}</span><span class="s2">&amp;&quot;</span> \
<span class="s2">&quot;location=</span><span class="si">{location}</span><span class="s2">&amp;&quot;</span> \
<span class="s2">&quot;instance=</span><span class="si">{instance}</span><span class="s2">&amp;&quot;</span> \
<span class="s2">&quot;use_proxy=False&amp;&quot;</span> \
<span class="s2">&quot;use_ssl=True&amp;&quot;</span> \
<span class="s2">&quot;sslcert=</span><span class="si">{client_cert_file}</span><span class="s2">&amp;&quot;</span> \
<span class="s2">&quot;sslkey=</span><span class="si">{client_key_file}</span><span class="s2">&amp;&quot;</span> \
<span class="s2">&quot;sslrootcert=</span><span class="si">{server_ca_file}</span><span class="s2">&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="o">**</span><span class="n">mysql_kwargs</span><span class="p">)</span>
<span class="c1"># Special case: MySQL: connect directly via TCP (SSL) and with fixed Cloud Sql</span>
<span class="c1"># Proxy binary path AND with missing project_id</span>
<span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s1">&#39;AIRFLOW_CONN_PUBLIC_MYSQL_TCP_SSL_NO_PROJECT_ID&#39;</span><span class="p">]</span> <span class="o">=</span> \
<span class="s2">&quot;gcpcloudsql://</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">?&quot;</span> \
<span class="s2">&quot;database_type=mysql&amp;&quot;</span> \
<span class="s2">&quot;location=</span><span class="si">{location}</span><span class="s2">&amp;&quot;</span> \
<span class="s2">&quot;instance=</span><span class="si">{instance}</span><span class="s2">&amp;&quot;</span> \
<span class="s2">&quot;use_proxy=False&amp;&quot;</span> \
<span class="s2">&quot;use_ssl=True&amp;&quot;</span> \
<span class="s2">&quot;sslcert=</span><span class="si">{client_cert_file}</span><span class="s2">&amp;&quot;</span> \
<span class="s2">&quot;sslkey=</span><span class="si">{client_key_file}</span><span class="s2">&amp;&quot;</span> \
<span class="s2">&quot;sslrootcert=</span><span class="si">{server_ca_file}</span><span class="s2">&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="o">**</span><span class="n">mysql_kwargs</span><span class="p">)</span>
<span class="c1"># [END howto_operator_cloudsql_query_connections]</span>
<span class="c1"># [START howto_operator_cloudsql_query_operators]</span>
<span class="n">connection_names</span> <span class="o">=</span> <span class="p">[</span>
<span class="s2">&quot;proxy_postgres_tcp&quot;</span><span class="p">,</span>
<span class="s2">&quot;proxy_postgres_socket&quot;</span><span class="p">,</span>
<span class="s2">&quot;public_postgres_tcp&quot;</span><span class="p">,</span>
<span class="s2">&quot;public_postgres_tcp_ssl&quot;</span><span class="p">,</span>
<span class="s2">&quot;proxy_mysql_tcp&quot;</span><span class="p">,</span>
<span class="s2">&quot;proxy_mysql_socket&quot;</span><span class="p">,</span>
<span class="s2">&quot;public_mysql_tcp&quot;</span><span class="p">,</span>
<span class="s2">&quot;public_mysql_tcp_ssl&quot;</span><span class="p">,</span>
<span class="s2">&quot;public_mysql_tcp_ssl_no_project_id&quot;</span>
<span class="p">]</span>
<span class="n">tasks</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">with</span> <span class="n">models</span><span class="o">.</span><span class="n">DAG</span><span class="p">(</span>
<span class="n">dag_id</span><span class="o">=</span><span class="s1">&#39;example_gcp_sql_query&#39;</span><span class="p">,</span>
<span class="n">default_args</span><span class="o">=</span><span class="n">default_args</span><span class="p">,</span>
<span class="n">schedule_interval</span><span class="o">=</span><span class="kc">None</span>
<span class="p">)</span> <span class="k">as</span> <span class="n">dag</span><span class="p">:</span>
<span class="n">prev_task</span> <span class="o">=</span> <span class="kc">None</span>
<span class="k">for</span> <span class="n">connection_name</span> <span class="ow">in</span> <span class="n">connection_names</span><span class="p">:</span>
<span class="n">task</span> <span class="o">=</span> <span class="n">CloudSqlQueryOperator</span><span class="p">(</span>
<span class="n">gcp_cloudsql_conn_id</span><span class="o">=</span><span class="n">connection_name</span><span class="p">,</span>
<span class="n">task_id</span><span class="o">=</span><span class="s2">&quot;example_gcp_sql_task_&quot;</span> <span class="o">+</span> <span class="n">connection_name</span><span class="p">,</span>
<span class="n">sql</span><span class="o">=</span><span class="n">SQL</span>
<span class="p">)</span>
<span class="n">tasks</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">task</span><span class="p">)</span>
<span class="k">if</span> <span class="n">prev_task</span><span class="p">:</span>
<span class="n">prev_task</span> <span class="o">&gt;&gt;</span> <span class="n">task</span>
<span class="n">prev_task</span> <span class="o">=</span> <span class="n">task</span>
<span class="c1"># [END howto_operator_cloudsql_query_operators]</span>
</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>