Google Git
Sign in
apache / airflow-site / f81e48aadee354653679693fa54b04ac42d24bfd / . / docs-archive / 1.10.4 / _modules / airflow / contrib / operators / gcp_spanner_operator.html
blob: c451912da373dc61299c08baacc4b51b0ffaae70 [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.operators.gcp_spanner_operator &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>
<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.4
</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</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">Experimental Rest API</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../integration.html">Integration</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../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">API Reference</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../../../index.html">Airflow</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../../../index.html">Docs</a> &raquo;</li>
<li><a href="../../../index.html">Module code</a> &raquo;</li>
<li><a href="../operators.html">airflow.contrib.operators</a> &raquo;</li>
<li>airflow.contrib.operators.gcp_spanner_operator</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.operators.gcp_spanner_operator</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="kn">import</span> <span class="nn">six</span>
<span class="kn">from</span> <span class="nn">airflow</span> <span class="k">import</span> <span class="n">AirflowException</span>
<span class="kn">from</span> <span class="nn">airflow.contrib.hooks.gcp_spanner_hook</span> <span class="k">import</span> <span class="n">CloudSpannerHook</span>
<span class="kn">from</span> <span class="nn">airflow.models</span> <span class="k">import</span> <span class="n">BaseOperator</span>
<span class="kn">from</span> <span class="nn">airflow.utils.decorators</span> <span class="k">import</span> <span class="n">apply_defaults</span>
<div class="viewcode-block" id="CloudSpannerInstanceDeployOperator"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_spanner_operator/index.html#airflow.contrib.operators.gcp_spanner_operator.CloudSpannerInstanceDeployOperator">[docs]</a><span class="k">class</span> <span class="nc">CloudSpannerInstanceDeployOperator</span><span class="p">(</span><span class="n">BaseOperator</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Creates a new Cloud Spanner instance, or if an instance with the same instance_id</span>
<span class="sd"> exists in the specified project, updates the Cloud Spanner instance.</span>
<span class="sd"> :param instance_id: Cloud Spanner instance ID.</span>
<span class="sd"> :type instance_id: str</span>
<span class="sd"> :param configuration_name: The name of the Cloud Spanner instance configuration</span>
<span class="sd"> defining how the instance will be created. Required for</span>
<span class="sd"> instances that do not yet exist.</span>
<span class="sd"> :type configuration_name: str</span>
<span class="sd"> :param node_count: (Optional) The number of nodes allocated to the Cloud Spanner</span>
<span class="sd"> instance.</span>
<span class="sd"> :type node_count: int</span>
<span class="sd"> :param display_name: (Optional) The display name for the Cloud Spanner instance in</span>
<span class="sd"> the GCP Console. (Must be between 4 and 30 characters.) If this value is not set</span>
<span class="sd"> in the constructor, the name is the same as the instance ID.</span>
<span class="sd"> :type display_name: str</span>
<span class="sd"> :param project_id: Optional, the ID of the project which owns the Cloud Spanner</span>
<span class="sd"> Database. If set 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 gcp_conn_id: The connection ID used to connect to Google Cloud Platform.</span>
<span class="sd"> :type gcp_conn_id: str</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="c1"># [START gcp_spanner_deploy_template_fields]</span>
<div class="viewcode-block" id="CloudSpannerInstanceDeployOperator.template_fields"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_spanner_operator/index.html#airflow.contrib.operators.gcp_spanner_operator.CloudSpannerInstanceDeployOperator.template_fields">[docs]</a> <span class="n">template_fields</span> <span class="o">=</span> <span class="p">(</span><span class="s1">&#39;project_id&#39;</span><span class="p">,</span> <span class="s1">&#39;instance_id&#39;</span><span class="p">,</span> <span class="s1">&#39;configuration_name&#39;</span><span class="p">,</span> <span class="s1">&#39;display_name&#39;</span><span class="p">,</span>
<span class="s1">&#39;gcp_conn_id&#39;</span><span class="p">)</span></div>
<span class="c1"># [END gcp_spanner_deploy_template_fields]</span>
<span class="nd">@apply_defaults</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">instance_id</span><span class="p">,</span>
<span class="n">configuration_name</span><span class="p">,</span>
<span class="n">node_count</span><span class="p">,</span>
<span class="n">display_name</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">gcp_conn_id</span><span class="o">=</span><span class="s1">&#39;google_cloud_default&#39;</span><span class="p">,</span>
<span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">instance_id</span> <span class="o">=</span> <span class="n">instance_id</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">configuration_name</span> <span class="o">=</span> <span class="n">configuration_name</span>
<span class="bp">self</span><span class="o">.</span><span class="n">node_count</span> <span class="o">=</span> <span class="n">node_count</span>
<span class="bp">self</span><span class="o">.</span><span class="n">display_name</span> <span class="o">=</span> <span class="n">display_name</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">_validate_inputs</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_hook</span> <span class="o">=</span> <span class="n">CloudSpannerHook</span><span class="p">(</span><span class="n">gcp_conn_id</span><span class="o">=</span><span class="n">gcp_conn_id</span><span class="p">)</span>
<span class="nb">super</span><span class="p">(</span><span class="n">CloudSpannerInstanceDeployOperator</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<div class="viewcode-block" id="CloudSpannerInstanceDeployOperator._validate_inputs"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_spanner_operator/index.html#airflow.contrib.operators.gcp_spanner_operator.CloudSpannerInstanceDeployOperator._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">&#39;&#39;</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s2">&quot;The required parameter &#39;project_id&#39; is empty&quot;</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_id</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s2">&quot;The required parameter &#39;instance_id&#39; &quot;</span></div>
<span class="s2">&quot;is empty or None&quot;</span><span class="p">)</span>
<div class="viewcode-block" id="CloudSpannerInstanceDeployOperator.execute"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_spanner_operator/index.html#airflow.contrib.operators.gcp_spanner_operator.CloudSpannerInstanceDeployOperator.execute">[docs]</a> <span class="k">def</span> <span class="nf">execute</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">context</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">_hook</span><span class="o">.</span><span class="n">get_instance</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">instance_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">instance_id</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">&quot;Creating Cloud Spanner instance &#39;</span><span class="si">%s</span><span class="s2">&#39;&quot;</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">instance_id</span><span class="p">)</span>
<span class="n">func</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_hook</span><span class="o">.</span><span class="n">create_instance</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">&quot;Updating Cloud Spanner instance &#39;</span><span class="si">%s</span><span class="s2">&#39;&quot;</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">instance_id</span><span class="p">)</span>
<span class="n">func</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_hook</span><span class="o">.</span><span class="n">update_instance</span>
<span class="n">func</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">instance_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">instance_id</span><span class="p">,</span>
<span class="n">configuration_name</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">configuration_name</span><span class="p">,</span>
<span class="n">node_count</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">node_count</span><span class="p">,</span>
<span class="n">display_name</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">display_name</span><span class="p">)</span></div></div>
<div class="viewcode-block" id="CloudSpannerInstanceDeleteOperator"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_spanner_operator/index.html#airflow.contrib.operators.gcp_spanner_operator.CloudSpannerInstanceDeleteOperator">[docs]</a><span class="k">class</span> <span class="nc">CloudSpannerInstanceDeleteOperator</span><span class="p">(</span><span class="n">BaseOperator</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Deletes a Cloud Spanner instance. If an instance does not exist,</span>
<span class="sd"> no action is taken and the operator succeeds.</span>
<span class="sd"> .. seealso::</span>
<span class="sd"> For more information on how to use this operator, take a look at the guide:</span>
<span class="sd"> :ref:`howto/operator:CloudSpannerInstanceDeleteOperator`</span>
<span class="sd"> :param instance_id: The Cloud Spanner instance ID.</span>
<span class="sd"> :type instance_id: str</span>
<span class="sd"> :param project_id: Optional, the ID of the project that owns the Cloud Spanner</span>
<span class="sd"> Database. If set 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 gcp_conn_id: The connection ID used to connect to Google Cloud Platform.</span>
<span class="sd"> :type gcp_conn_id: str</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="c1"># [START gcp_spanner_delete_template_fields]</span>
<div class="viewcode-block" id="CloudSpannerInstanceDeleteOperator.template_fields"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_spanner_operator/index.html#airflow.contrib.operators.gcp_spanner_operator.CloudSpannerInstanceDeleteOperator.template_fields">[docs]</a> <span class="n">template_fields</span> <span class="o">=</span> <span class="p">(</span><span class="s1">&#39;project_id&#39;</span><span class="p">,</span> <span class="s1">&#39;instance_id&#39;</span><span class="p">,</span> <span class="s1">&#39;gcp_conn_id&#39;</span><span class="p">)</span></div>
<span class="c1"># [END gcp_spanner_delete_template_fields]</span>
<span class="nd">@apply_defaults</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">instance_id</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">gcp_conn_id</span><span class="o">=</span><span class="s1">&#39;google_cloud_default&#39;</span><span class="p">,</span>
<span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">instance_id</span> <span class="o">=</span> <span class="n">instance_id</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">_validate_inputs</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_hook</span> <span class="o">=</span> <span class="n">CloudSpannerHook</span><span class="p">(</span><span class="n">gcp_conn_id</span><span class="o">=</span><span class="n">gcp_conn_id</span><span class="p">)</span>
<span class="nb">super</span><span class="p">(</span><span class="n">CloudSpannerInstanceDeleteOperator</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<div class="viewcode-block" id="CloudSpannerInstanceDeleteOperator._validate_inputs"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_spanner_operator/index.html#airflow.contrib.operators.gcp_spanner_operator.CloudSpannerInstanceDeleteOperator._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">&#39;&#39;</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s2">&quot;The required parameter &#39;project_id&#39; is empty&quot;</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_id</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s2">&quot;The required parameter &#39;instance_id&#39; &quot;</span></div>
<span class="s2">&quot;is empty or None&quot;</span><span class="p">)</span>
<div class="viewcode-block" id="CloudSpannerInstanceDeleteOperator.execute"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_spanner_operator/index.html#airflow.contrib.operators.gcp_spanner_operator.CloudSpannerInstanceDeleteOperator.execute">[docs]</a> <span class="k">def</span> <span class="nf">execute</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">context</span><span class="p">):</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_hook</span><span class="o">.</span><span class="n">get_instance</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">instance_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">instance_id</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_hook</span><span class="o">.</span><span class="n">delete_instance</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">instance_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">instance_id</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">&quot;Instance &#39;</span><span class="si">%s</span><span class="s2">&#39; does not exist in project &#39;</span><span class="si">%s</span><span class="s2">&#39;. &quot;</span>
<span class="s2">&quot;Aborting delete.&quot;</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">instance_id</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="k">return</span> <span class="kc">True</span></div></div>
<div class="viewcode-block" id="CloudSpannerInstanceDatabaseQueryOperator"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_spanner_operator/index.html#airflow.contrib.operators.gcp_spanner_operator.CloudSpannerInstanceDatabaseQueryOperator">[docs]</a><span class="k">class</span> <span class="nc">CloudSpannerInstanceDatabaseQueryOperator</span><span class="p">(</span><span class="n">BaseOperator</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Executes an arbitrary DML query (INSERT, UPDATE, DELETE).</span>
<span class="sd"> .. seealso::</span>
<span class="sd"> For more information on how to use this operator, take a look at the guide:</span>
<span class="sd"> :ref:`howto/operator:CloudSpannerInstanceDatabaseQueryOperator`</span>
<span class="sd"> :param instance_id: The Cloud Spanner instance ID.</span>
<span class="sd"> :type instance_id: str</span>
<span class="sd"> :param database_id: The Cloud Spanner database ID.</span>
<span class="sd"> :type database_id: str</span>
<span class="sd"> :param query: The query or list of queries to be executed. Can be a path to a SQL</span>
<span class="sd"> file.</span>
<span class="sd"> :type query: str or list</span>
<span class="sd"> :param project_id: Optional, the ID of the project that owns the Cloud Spanner</span>
<span class="sd"> Database. If set 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 gcp_conn_id: The connection ID used to connect to Google Cloud Platform.</span>
<span class="sd"> :type gcp_conn_id: str</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="c1"># [START gcp_spanner_query_template_fields]</span>
<div class="viewcode-block" id="CloudSpannerInstanceDatabaseQueryOperator.template_fields"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_spanner_operator/index.html#airflow.contrib.operators.gcp_spanner_operator.CloudSpannerInstanceDatabaseQueryOperator.template_fields">[docs]</a> <span class="n">template_fields</span> <span class="o">=</span> <span class="p">(</span><span class="s1">&#39;project_id&#39;</span><span class="p">,</span> <span class="s1">&#39;instance_id&#39;</span><span class="p">,</span> <span class="s1">&#39;database_id&#39;</span><span class="p">,</span> <span class="s1">&#39;query&#39;</span><span class="p">,</span> <span class="s1">&#39;gcp_conn_id&#39;</span><span class="p">)</span></div>
<div class="viewcode-block" id="CloudSpannerInstanceDatabaseQueryOperator.template_ext"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_spanner_operator/index.html#airflow.contrib.operators.gcp_spanner_operator.CloudSpannerInstanceDatabaseQueryOperator.template_ext">[docs]</a> <span class="n">template_ext</span> <span class="o">=</span> <span class="p">(</span><span class="s1">&#39;.sql&#39;</span><span class="p">,)</span></div>
<span class="c1"># [END gcp_spanner_query_template_fields]</span>
<span class="nd">@apply_defaults</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">instance_id</span><span class="p">,</span>
<span class="n">database_id</span><span class="p">,</span>
<span class="n">query</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">gcp_conn_id</span><span class="o">=</span><span class="s1">&#39;google_cloud_default&#39;</span><span class="p">,</span>
<span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">instance_id</span> <span class="o">=</span> <span class="n">instance_id</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">database_id</span> <span class="o">=</span> <span class="n">database_id</span>
<span class="bp">self</span><span class="o">.</span><span class="n">query</span> <span class="o">=</span> <span class="n">query</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">_validate_inputs</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_hook</span> <span class="o">=</span> <span class="n">CloudSpannerHook</span><span class="p">(</span><span class="n">gcp_conn_id</span><span class="o">=</span><span class="n">gcp_conn_id</span><span class="p">)</span>
<span class="nb">super</span><span class="p">(</span><span class="n">CloudSpannerInstanceDatabaseQueryOperator</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<div class="viewcode-block" id="CloudSpannerInstanceDatabaseQueryOperator._validate_inputs"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_spanner_operator/index.html#airflow.contrib.operators.gcp_spanner_operator.CloudSpannerInstanceDatabaseQueryOperator._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">&#39;&#39;</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s2">&quot;The required parameter &#39;project_id&#39; is empty&quot;</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_id</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s2">&quot;The required parameter &#39;instance_id&#39; &quot;</span>
<span class="s2">&quot;is empty or None&quot;</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_id</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s2">&quot;The required parameter &#39;database_id&#39; &quot;</span>
<span class="s2">&quot;is empty or None&quot;</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">query</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s2">&quot;The required parameter &#39;query&#39; is empty&quot;</span><span class="p">)</span></div>
<div class="viewcode-block" id="CloudSpannerInstanceDatabaseQueryOperator.execute"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_spanner_operator/index.html#airflow.contrib.operators.gcp_spanner_operator.CloudSpannerInstanceDatabaseQueryOperator.execute">[docs]</a> <span class="k">def</span> <span class="nf">execute</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">context</span><span class="p">):</span>
<span class="n">queries</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">query</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">query</span><span class="p">,</span> <span class="n">six</span><span class="o">.</span><span class="n">string_types</span><span class="p">):</span>
<span class="n">queries</span> <span class="o">=</span> <span class="p">[</span><span class="n">x</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">query</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">&#39;;&#39;</span><span class="p">)]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">sanitize_queries</span><span class="p">(</span><span class="n">queries</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">&quot;Executing DML query(-ies) on &quot;</span>
<span class="s2">&quot;projects/</span><span class="si">%s</span><span class="s2">/instances/</span><span class="si">%s</span><span class="s2">/databases/</span><span class="si">%s</span><span class="s2">&quot;</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_id</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">database_id</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">queries</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_hook</span><span class="o">.</span><span class="n">execute_dml</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">instance_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">instance_id</span><span class="p">,</span>
<span class="n">database_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">database_id</span><span class="p">,</span>
<span class="n">queries</span><span class="o">=</span><span class="n">queries</span><span class="p">)</span></div>
<span class="nd">@staticmethod</span>
<div class="viewcode-block" id="CloudSpannerInstanceDatabaseQueryOperator.sanitize_queries"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_spanner_operator/index.html#airflow.contrib.operators.gcp_spanner_operator.CloudSpannerInstanceDatabaseQueryOperator.sanitize_queries">[docs]</a> <span class="k">def</span> <span class="nf">sanitize_queries</span><span class="p">(</span><span class="n">queries</span><span class="p">):</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">queries</span><span class="p">)</span> <span class="ow">and</span> <span class="n">queries</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> <span class="o">==</span> <span class="s1">&#39;&#39;</span><span class="p">:</span>
<span class="k">del</span> <span class="n">queries</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span></div></div>
<div class="viewcode-block" id="CloudSpannerInstanceDatabaseDeployOperator"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_spanner_operator/index.html#airflow.contrib.operators.gcp_spanner_operator.CloudSpannerInstanceDatabaseDeployOperator">[docs]</a><span class="k">class</span> <span class="nc">CloudSpannerInstanceDatabaseDeployOperator</span><span class="p">(</span><span class="n">BaseOperator</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Creates a new Cloud Spanner database, or if database exists,</span>
<span class="sd"> the operator does nothing.</span>
<span class="sd"> .. seealso::</span>
<span class="sd"> For more information on how to use this operator, take a look at the guide:</span>
<span class="sd"> :ref:`howto/operator:CloudSpannerInstanceDatabaseDeployOperator`</span>
<span class="sd"> :param instance_id: The Cloud Spanner instance ID.</span>
<span class="sd"> :type instance_id: str</span>
<span class="sd"> :param database_id: The Cloud Spanner database ID.</span>
<span class="sd"> :type database_id: str</span>
<span class="sd"> :param ddl_statements: The string list containing DDL for the new database.</span>
<span class="sd"> :type ddl_statements: list[str]</span>
<span class="sd"> :param project_id: Optional, the ID of the project that owns the Cloud Spanner</span>
<span class="sd"> Database. If set 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 gcp_conn_id: The connection ID used to connect to Google Cloud Platform.</span>
<span class="sd"> :type gcp_conn_id: str</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="c1"># [START gcp_spanner_database_deploy_template_fields]</span>
<div class="viewcode-block" id="CloudSpannerInstanceDatabaseDeployOperator.template_fields"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_spanner_operator/index.html#airflow.contrib.operators.gcp_spanner_operator.CloudSpannerInstanceDatabaseDeployOperator.template_fields">[docs]</a> <span class="n">template_fields</span> <span class="o">=</span> <span class="p">(</span><span class="s1">&#39;project_id&#39;</span><span class="p">,</span> <span class="s1">&#39;instance_id&#39;</span><span class="p">,</span> <span class="s1">&#39;database_id&#39;</span><span class="p">,</span> <span class="s1">&#39;ddl_statements&#39;</span><span class="p">,</span>
<span class="s1">&#39;gcp_conn_id&#39;</span><span class="p">)</span></div>
<div class="viewcode-block" id="CloudSpannerInstanceDatabaseDeployOperator.template_ext"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_spanner_operator/index.html#airflow.contrib.operators.gcp_spanner_operator.CloudSpannerInstanceDatabaseDeployOperator.template_ext">[docs]</a> <span class="n">template_ext</span> <span class="o">=</span> <span class="p">(</span><span class="s1">&#39;.sql&#39;</span><span class="p">,</span> <span class="p">)</span></div>
<span class="c1"># [END gcp_spanner_database_deploy_template_fields]</span>
<span class="nd">@apply_defaults</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">instance_id</span><span class="p">,</span>
<span class="n">database_id</span><span class="p">,</span>
<span class="n">ddl_statements</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">gcp_conn_id</span><span class="o">=</span><span class="s1">&#39;google_cloud_default&#39;</span><span class="p">,</span>
<span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">instance_id</span> <span class="o">=</span> <span class="n">instance_id</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">database_id</span> <span class="o">=</span> <span class="n">database_id</span>
<span class="bp">self</span><span class="o">.</span><span class="n">ddl_statements</span> <span class="o">=</span> <span class="n">ddl_statements</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">_validate_inputs</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_hook</span> <span class="o">=</span> <span class="n">CloudSpannerHook</span><span class="p">(</span><span class="n">gcp_conn_id</span><span class="o">=</span><span class="n">gcp_conn_id</span><span class="p">)</span>
<span class="nb">super</span><span class="p">(</span><span class="n">CloudSpannerInstanceDatabaseDeployOperator</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<div class="viewcode-block" id="CloudSpannerInstanceDatabaseDeployOperator._validate_inputs"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_spanner_operator/index.html#airflow.contrib.operators.gcp_spanner_operator.CloudSpannerInstanceDatabaseDeployOperator._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">&#39;&#39;</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s2">&quot;The required parameter &#39;project_id&#39; is empty&quot;</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_id</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s2">&quot;The required parameter &#39;instance_id&#39; is empty &quot;</span>
<span class="s2">&quot;or None&quot;</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_id</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s2">&quot;The required parameter &#39;database_id&#39; is empty&quot;</span></div>
<span class="s2">&quot; or None&quot;</span><span class="p">)</span>
<div class="viewcode-block" id="CloudSpannerInstanceDatabaseDeployOperator.execute"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_spanner_operator/index.html#airflow.contrib.operators.gcp_spanner_operator.CloudSpannerInstanceDatabaseDeployOperator.execute">[docs]</a> <span class="k">def</span> <span class="nf">execute</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">context</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">_hook</span><span class="o">.</span><span class="n">get_database</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">instance_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">instance_id</span><span class="p">,</span>
<span class="n">database_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">database_id</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">&quot;Creating Cloud Spanner database &quot;</span>
<span class="s2">&quot;&#39;</span><span class="si">%s</span><span class="s2">&#39; in project &#39;</span><span class="si">%s</span><span class="s2">&#39; and instance &#39;</span><span class="si">%s</span><span class="s2">&#39;&quot;</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">database_id</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_id</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_hook</span><span class="o">.</span><span class="n">create_database</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">instance_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">instance_id</span><span class="p">,</span>
<span class="n">database_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">database_id</span><span class="p">,</span>
<span class="n">ddl_statements</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">ddl_statements</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">&quot;The database &#39;</span><span class="si">%s</span><span class="s2">&#39; in project &#39;</span><span class="si">%s</span><span class="s2">&#39; and instance &#39;</span><span class="si">%s</span><span class="s2">&#39;&quot;</span>
<span class="s2">&quot; already exists. Nothing to do. Exiting.&quot;</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">database_id</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_id</span><span class="p">)</span>
<span class="k">return</span> <span class="kc">True</span></div></div>
<div class="viewcode-block" id="CloudSpannerInstanceDatabaseUpdateOperator"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_spanner_operator/index.html#airflow.contrib.operators.gcp_spanner_operator.CloudSpannerInstanceDatabaseUpdateOperator">[docs]</a><span class="k">class</span> <span class="nc">CloudSpannerInstanceDatabaseUpdateOperator</span><span class="p">(</span><span class="n">BaseOperator</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Updates a Cloud Spanner database with the specified DDL statement.</span>
<span class="sd"> .. seealso::</span>
<span class="sd"> For more information on how to use this operator, take a look at the guide:</span>
<span class="sd"> :ref:`howto/operator:CloudSpannerInstanceDatabaseUpdateOperator`</span>
<span class="sd"> :param instance_id: The Cloud Spanner instance ID.</span>
<span class="sd"> :type instance_id: str</span>
<span class="sd"> :param database_id: The Cloud Spanner database ID.</span>
<span class="sd"> :type database_id: str</span>
<span class="sd"> :param ddl_statements: The string list containing DDL to apply to the database.</span>
<span class="sd"> :type ddl_statements: list[str]</span>
<span class="sd"> :param project_id: Optional, the ID of the project that owns the the Cloud Spanner</span>
<span class="sd"> Database. If set 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 operation_id: (Optional) Unique per database operation id that can</span>
<span class="sd"> be specified to implement idempotency check.</span>
<span class="sd"> :type operation_id: str</span>
<span class="sd"> :param gcp_conn_id: The connection ID used to connect to Google Cloud Platform.</span>
<span class="sd"> :type gcp_conn_id: str</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="c1"># [START gcp_spanner_database_update_template_fields]</span>
<div class="viewcode-block" id="CloudSpannerInstanceDatabaseUpdateOperator.template_fields"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_spanner_operator/index.html#airflow.contrib.operators.gcp_spanner_operator.CloudSpannerInstanceDatabaseUpdateOperator.template_fields">[docs]</a> <span class="n">template_fields</span> <span class="o">=</span> <span class="p">(</span><span class="s1">&#39;project_id&#39;</span><span class="p">,</span> <span class="s1">&#39;instance_id&#39;</span><span class="p">,</span> <span class="s1">&#39;database_id&#39;</span><span class="p">,</span> <span class="s1">&#39;ddl_statements&#39;</span><span class="p">,</span>
<span class="s1">&#39;gcp_conn_id&#39;</span><span class="p">)</span></div>
<div class="viewcode-block" id="CloudSpannerInstanceDatabaseUpdateOperator.template_ext"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_spanner_operator/index.html#airflow.contrib.operators.gcp_spanner_operator.CloudSpannerInstanceDatabaseUpdateOperator.template_ext">[docs]</a> <span class="n">template_ext</span> <span class="o">=</span> <span class="p">(</span><span class="s1">&#39;.sql&#39;</span><span class="p">,</span> <span class="p">)</span></div>
<span class="c1"># [END gcp_spanner_database_update_template_fields]</span>
<span class="nd">@apply_defaults</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">instance_id</span><span class="p">,</span>
<span class="n">database_id</span><span class="p">,</span>
<span class="n">ddl_statements</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">operation_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">gcp_conn_id</span><span class="o">=</span><span class="s1">&#39;google_cloud_default&#39;</span><span class="p">,</span>
<span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">instance_id</span> <span class="o">=</span> <span class="n">instance_id</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">database_id</span> <span class="o">=</span> <span class="n">database_id</span>
<span class="bp">self</span><span class="o">.</span><span class="n">ddl_statements</span> <span class="o">=</span> <span class="n">ddl_statements</span>
<span class="bp">self</span><span class="o">.</span><span class="n">operation_id</span> <span class="o">=</span> <span class="n">operation_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">_validate_inputs</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_hook</span> <span class="o">=</span> <span class="n">CloudSpannerHook</span><span class="p">(</span><span class="n">gcp_conn_id</span><span class="o">=</span><span class="n">gcp_conn_id</span><span class="p">)</span>
<span class="nb">super</span><span class="p">(</span><span class="n">CloudSpannerInstanceDatabaseUpdateOperator</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<div class="viewcode-block" id="CloudSpannerInstanceDatabaseUpdateOperator._validate_inputs"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_spanner_operator/index.html#airflow.contrib.operators.gcp_spanner_operator.CloudSpannerInstanceDatabaseUpdateOperator._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">&#39;&#39;</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s2">&quot;The required parameter &#39;project_id&#39; is empty&quot;</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_id</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s2">&quot;The required parameter &#39;instance_id&#39; is empty&quot;</span>
<span class="s2">&quot; or None&quot;</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_id</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s2">&quot;The required parameter &#39;database_id&#39; is empty&quot;</span>
<span class="s2">&quot; or None&quot;</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">ddl_statements</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s2">&quot;The required parameter &#39;ddl_statements&#39; is empty&quot;</span></div>
<span class="s2">&quot; or None&quot;</span><span class="p">)</span>
<div class="viewcode-block" id="CloudSpannerInstanceDatabaseUpdateOperator.execute"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_spanner_operator/index.html#airflow.contrib.operators.gcp_spanner_operator.CloudSpannerInstanceDatabaseUpdateOperator.execute">[docs]</a> <span class="k">def</span> <span class="nf">execute</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">context</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">_hook</span><span class="o">.</span><span class="n">get_database</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">instance_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">instance_id</span><span class="p">,</span>
<span class="n">database_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">database_id</span><span class="p">):</span>
<span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s2">&quot;The Cloud Spanner database &#39;</span><span class="si">{}</span><span class="s2">&#39; in project &#39;</span><span class="si">{}</span><span class="s2">&#39; and &quot;</span>
<span class="s2">&quot;instance &#39;</span><span class="si">{}</span><span class="s2">&#39; is missing. Create the database first &quot;</span>
<span class="s2">&quot;before you can update it.&quot;</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_id</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_id</span><span class="p">))</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_hook</span><span class="o">.</span><span class="n">update_database</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">instance_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">instance_id</span><span class="p">,</span>
<span class="n">database_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">database_id</span><span class="p">,</span>
<span class="n">ddl_statements</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">ddl_statements</span><span class="p">,</span>
<span class="n">operation_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">operation_id</span><span class="p">)</span></div></div>
<div class="viewcode-block" id="CloudSpannerInstanceDatabaseDeleteOperator"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_spanner_operator/index.html#airflow.contrib.operators.gcp_spanner_operator.CloudSpannerInstanceDatabaseDeleteOperator">[docs]</a><span class="k">class</span> <span class="nc">CloudSpannerInstanceDatabaseDeleteOperator</span><span class="p">(</span><span class="n">BaseOperator</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Deletes a Cloud Spanner database.</span>
<span class="sd"> .. seealso::</span>
<span class="sd"> For more information on how to use this operator, take a look at the guide:</span>
<span class="sd"> :ref:`howto/operator:CloudSpannerInstanceDatabaseDeleteOperator`</span>
<span class="sd"> :param instance_id: Cloud Spanner instance ID.</span>
<span class="sd"> :type instance_id: str</span>
<span class="sd"> :param database_id: Cloud Spanner database ID.</span>
<span class="sd"> :type database_id: str</span>
<span class="sd"> :param project_id: Optional, the ID of the project that owns the Cloud Spanner</span>
<span class="sd"> Database. If set 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 gcp_conn_id: The connection ID used to connect to Google Cloud Platform.</span>
<span class="sd"> :type gcp_conn_id: str</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="c1"># [START gcp_spanner_database_delete_template_fields]</span>
<div class="viewcode-block" id="CloudSpannerInstanceDatabaseDeleteOperator.template_fields"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_spanner_operator/index.html#airflow.contrib.operators.gcp_spanner_operator.CloudSpannerInstanceDatabaseDeleteOperator.template_fields">[docs]</a> <span class="n">template_fields</span> <span class="o">=</span> <span class="p">(</span><span class="s1">&#39;project_id&#39;</span><span class="p">,</span> <span class="s1">&#39;instance_id&#39;</span><span class="p">,</span> <span class="s1">&#39;database_id&#39;</span><span class="p">,</span>
<span class="s1">&#39;gcp_conn_id&#39;</span><span class="p">)</span></div>
<span class="c1"># [END gcp_spanner_database_delete_template_fields]</span>
<span class="nd">@apply_defaults</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">instance_id</span><span class="p">,</span>
<span class="n">database_id</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">gcp_conn_id</span><span class="o">=</span><span class="s1">&#39;google_cloud_default&#39;</span><span class="p">,</span>
<span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">instance_id</span> <span class="o">=</span> <span class="n">instance_id</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">database_id</span> <span class="o">=</span> <span class="n">database_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">_validate_inputs</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_hook</span> <span class="o">=</span> <span class="n">CloudSpannerHook</span><span class="p">(</span><span class="n">gcp_conn_id</span><span class="o">=</span><span class="n">gcp_conn_id</span><span class="p">)</span>
<span class="nb">super</span><span class="p">(</span><span class="n">CloudSpannerInstanceDatabaseDeleteOperator</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<div class="viewcode-block" id="CloudSpannerInstanceDatabaseDeleteOperator._validate_inputs"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_spanner_operator/index.html#airflow.contrib.operators.gcp_spanner_operator.CloudSpannerInstanceDatabaseDeleteOperator._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">&#39;&#39;</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s2">&quot;The required parameter &#39;project_id&#39; is empty&quot;</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_id</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s2">&quot;The required parameter &#39;instance_id&#39; is empty&quot;</span>
<span class="s2">&quot; or None&quot;</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_id</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s2">&quot;The required parameter &#39;database_id&#39; is empty&quot;</span></div>
<span class="s2">&quot; or None&quot;</span><span class="p">)</span>
<div class="viewcode-block" id="CloudSpannerInstanceDatabaseDeleteOperator.execute"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_spanner_operator/index.html#airflow.contrib.operators.gcp_spanner_operator.CloudSpannerInstanceDatabaseDeleteOperator.execute">[docs]</a> <span class="k">def</span> <span class="nf">execute</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">context</span><span class="p">):</span>
<span class="n">db</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_hook</span><span class="o">.</span><span class="n">get_database</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">instance_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">instance_id</span><span class="p">,</span>
<span class="n">database_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">database_id</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">db</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">&quot;The Cloud Spanner database was missing: &quot;</span>
<span class="s2">&quot;&#39;</span><span class="si">%s</span><span class="s2">&#39; in project &#39;</span><span class="si">%s</span><span class="s2">&#39; and instance &#39;</span><span class="si">%s</span><span class="s2">&#39;. Assuming success.&quot;</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">database_id</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_id</span><span class="p">)</span>
<span class="k">return</span> <span class="kc">True</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_hook</span><span class="o">.</span><span class="n">delete_database</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">instance_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">instance_id</span><span class="p">,</span>
<span class="n">database_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">database_id</span><span class="p">)</span></div></div>
</pre></div>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>