blob: 8836f344144fd7ceb8bb35b220a603b2052e096c [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.hooks.gcp_spanner_hook &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>
<script type="application/javascript">
window.ga=window.ga||function(){(ga.q=ga.q||[]).push(arguments)};ga.l=+new Date;
ga("create", "UA-140539454-1", "auto");
ga("send", "pageview");
</script>
<script async src="https://www.google-analytics.com/analytics.js"></script>
</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="../hooks.html">airflow.contrib.hooks</a> &raquo;</li>
<li>airflow.contrib.hooks.gcp_spanner_hook</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<h1>Source code for airflow.contrib.hooks.gcp_spanner_hook</h1><div class="highlight"><pre>
<span></span><span class="c1"># -*- coding: utf-8 -*-</span>
<span class="c1">#</span>
<span class="c1"># Licensed to the Apache Software Foundation (ASF) under one</span>
<span class="c1"># or more contributor license agreements. See the NOTICE file</span>
<span class="c1"># distributed with this work for additional information</span>
<span class="c1"># regarding copyright ownership. The ASF licenses this file</span>
<span class="c1"># to you under the Apache License, Version 2.0 (the</span>
<span class="c1"># &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">from</span> <span class="nn">google.api_core.exceptions</span> <span class="k">import</span> <span class="n">GoogleAPICallError</span><span class="p">,</span> <span class="n">AlreadyExists</span>
<span class="kn">from</span> <span class="nn">google.cloud.spanner_v1.client</span> <span class="k">import</span> <span class="n">Client</span>
<span class="kn">from</span> <span class="nn">google.longrunning.operations_grpc_pb2</span> <span class="k">import</span> <span class="n">Operation</span> <span class="c1"># noqa: F401</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_api_base_hook</span> <span class="k">import</span> <span class="n">GoogleCloudBaseHook</span>
<div class="viewcode-block" id="CloudSpannerHook"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_spanner_hook/index.html#airflow.contrib.hooks.gcp_spanner_hook.CloudSpannerHook">[docs]</a><span class="k">class</span> <span class="nc">CloudSpannerHook</span><span class="p">(</span><span class="n">GoogleCloudBaseHook</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Hook for Google Cloud Spanner APIs.</span>
<span class="sd"> All the methods in the hook where project_id is used must be called with</span>
<span class="sd"> keyword arguments rather than positional.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<div class="viewcode-block" id="CloudSpannerHook._client"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_spanner_hook/index.html#airflow.contrib.hooks.gcp_spanner_hook.CloudSpannerHook._client">[docs]</a> <span class="n">_client</span> <span class="o">=</span> <span class="kc">None</span></div>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
<span class="n">gcp_conn_id</span><span class="o">=</span><span class="s1">&#39;google_cloud_default&#39;</span><span class="p">,</span>
<span class="n">delegate_to</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="nb">super</span><span class="p">(</span><span class="n">CloudSpannerHook</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">gcp_conn_id</span><span class="p">,</span> <span class="n">delegate_to</span><span class="p">)</span>
<div class="viewcode-block" id="CloudSpannerHook._get_client"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_spanner_hook/index.html#airflow.contrib.hooks.gcp_spanner_hook.CloudSpannerHook._get_client">[docs]</a> <span class="k">def</span> <span class="nf">_get_client</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">project_id</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Provides a client for interacting with the Cloud Spanner API.</span>
<span class="sd"> :param project_id: The ID of the GCP project.</span>
<span class="sd"> :type project_id: str</span>
<span class="sd"> :return: google.cloud.spanner_v1.client.Client</span>
<span class="sd"> :rtype: object</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">Client</span><span class="p">(</span><span class="n">project</span><span class="o">=</span><span class="n">project_id</span><span class="p">,</span> <span class="n">credentials</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_get_credentials</span><span class="p">())</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span></div>
<span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">fallback_to_default_project_id</span>
<div class="viewcode-block" id="CloudSpannerHook.get_instance"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_spanner_hook/index.html#airflow.contrib.hooks.gcp_spanner_hook.CloudSpannerHook.get_instance">[docs]</a> <span class="k">def</span> <span class="nf">get_instance</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">instance_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="sd">&quot;&quot;&quot;</span>
<span class="sd"> Gets information about a particular instance.</span>
<span class="sd"> :param project_id: Optional, The ID of the GCP 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 instance_id: The ID of the Cloud Spanner instance.</span>
<span class="sd"> :type instance_id: str</span>
<span class="sd"> :return: google.cloud.spanner_v1.instance.Instance</span>
<span class="sd"> :rtype: object</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">instance</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_client</span><span class="p">(</span><span class="n">project_id</span><span class="o">=</span><span class="n">project_id</span><span class="p">)</span><span class="o">.</span><span class="n">instance</span><span class="p">(</span><span class="n">instance_id</span><span class="o">=</span><span class="n">instance_id</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">instance</span><span class="o">.</span><span class="n">exists</span><span class="p">():</span>
<span class="k">return</span> <span class="kc">None</span>
<span class="k">return</span> <span class="n">instance</span></div>
<div class="viewcode-block" id="CloudSpannerHook._apply_to_instance"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_spanner_hook/index.html#airflow.contrib.hooks.gcp_spanner_hook.CloudSpannerHook._apply_to_instance">[docs]</a> <span class="k">def</span> <span class="nf">_apply_to_instance</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">project_id</span><span class="p">,</span> <span class="n">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">func</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Invokes a method on a given instance by applying a specified Callable.</span>
<span class="sd"> :param project_id: The ID of the GCP project that owns the Cloud Spanner</span>
<span class="sd"> database.</span>
<span class="sd"> :type project_id: str</span>
<span class="sd"> :param instance_id: The ID of the instance.</span>
<span class="sd"> :type instance_id: str</span>
<span class="sd"> :param configuration_name: Name of the instance configuration defining how the</span>
<span class="sd"> instance will be created. Required for instances which do not yet exist.</span>
<span class="sd"> :type configuration_name: str</span>
<span class="sd"> :param node_count: (Optional) Number of nodes allocated to the instance.</span>
<span class="sd"> :type node_count: int</span>
<span class="sd"> :param display_name: (Optional) The display name for the instance in the Cloud</span>
<span class="sd"> Console UI. (Must be between 4 and 30 characters.) If this value is not set</span>
<span class="sd"> in the constructor, will fall back to the instance ID.</span>
<span class="sd"> :type display_name: str</span>
<span class="sd"> :param func: Method of the instance to be called.</span>
<span class="sd"> :type func: Callable</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="c1"># noinspection PyUnresolvedReferences</span>
<span class="n">instance</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_client</span><span class="p">(</span><span class="n">project_id</span><span class="o">=</span><span class="n">project_id</span><span class="p">)</span><span class="o">.</span><span class="n">instance</span><span class="p">(</span>
<span class="n">instance_id</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="n">configuration_name</span><span class="p">,</span>
<span class="n">node_count</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="n">display_name</span><span class="p">)</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">operation</span> <span class="o">=</span> <span class="n">func</span><span class="p">(</span><span class="n">instance</span><span class="p">)</span> <span class="c1"># type: Operation</span>
<span class="k">except</span> <span class="n">GoogleAPICallError</span> <span class="k">as</span> <span class="n">e</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">error</span><span class="p">(</span><span class="s1">&#39;An error occurred: </span><span class="si">%s</span><span class="s1">. Exiting.&#39;</span><span class="p">,</span> <span class="n">e</span><span class="o">.</span><span class="n">message</span><span class="p">)</span>
<span class="k">raise</span> <span class="n">e</span>
<span class="k">if</span> <span class="n">operation</span><span class="p">:</span>
<span class="n">result</span> <span class="o">=</span> <span class="n">operation</span><span class="o">.</span><span class="n">result</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">result</span><span class="p">)</span></div>
<span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">fallback_to_default_project_id</span>
<div class="viewcode-block" id="CloudSpannerHook.create_instance"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_spanner_hook/index.html#airflow.contrib.hooks.gcp_spanner_hook.CloudSpannerHook.create_instance">[docs]</a> <span class="k">def</span> <span class="nf">create_instance</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">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="sd">&quot;&quot;&quot;</span>
<span class="sd"> Creates a new Cloud Spanner instance.</span>
<span class="sd"> :param instance_id: The ID of the Cloud Spanner instance.</span>
<span class="sd"> :type instance_id: str</span>
<span class="sd"> :param configuration_name: The name of the instance configuration defining how the</span>
<span class="sd"> instance will be created. Possible configuration values can be retrieved via</span>
<span class="sd"> https://cloud.google.com/spanner/docs/reference/rest/v1/projects.instanceConfigs/list</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 instance in the GCP</span>
<span class="sd"> Console. Must be between 4 and 30 characters. If this value is not set in</span>
<span class="sd"> the constructor, the name falls back to the instance ID.</span>
<span class="sd"> :type display_name: str</span>
<span class="sd"> :param project_id: Optional, the ID of the GCP 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"> :return: None</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_apply_to_instance</span><span class="p">(</span><span class="n">project_id</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="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="n">x</span><span class="o">.</span><span class="n">create</span><span class="p">())</span></div>
<span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">fallback_to_default_project_id</span>
<div class="viewcode-block" id="CloudSpannerHook.update_instance"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_spanner_hook/index.html#airflow.contrib.hooks.gcp_spanner_hook.CloudSpannerHook.update_instance">[docs]</a> <span class="k">def</span> <span class="nf">update_instance</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="sd">&quot;&quot;&quot;</span>
<span class="sd"> Updates an existing Cloud Spanner instance.</span>
<span class="sd"> :param instance_id: The ID of the Cloud Spanner instance.</span>
<span class="sd"> :type instance_id: str</span>
<span class="sd"> :param configuration_name: The name of the instance configuration defining how the</span>
<span class="sd"> instance will be created. Possible configuration values can be retrieved via</span>
<span class="sd"> https://cloud.google.com/spanner/docs/reference/rest/v1/projects.instanceConfigs/list</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 instance in the GCP</span>
<span class="sd"> Console. Must be between 4 and 30 characters. If this value is not set in</span>
<span class="sd"> the constructor, the name falls back to the instance ID.</span>
<span class="sd"> :type display_name: str</span>
<span class="sd"> :param project_id: Optional, the ID of the GCP 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"> :return: None</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_apply_to_instance</span><span class="p">(</span><span class="n">project_id</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="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="n">x</span><span class="o">.</span><span class="n">update</span><span class="p">())</span></div>
<span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">fallback_to_default_project_id</span>
<div class="viewcode-block" id="CloudSpannerHook.delete_instance"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_spanner_hook/index.html#airflow.contrib.hooks.gcp_spanner_hook.CloudSpannerHook.delete_instance">[docs]</a> <span class="k">def</span> <span class="nf">delete_instance</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">instance_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="sd">&quot;&quot;&quot;</span>
<span class="sd"> Deletes an existing Cloud Spanner instance.</span>
<span class="sd"> :param instance_id: The ID of the Cloud Spanner instance.</span>
<span class="sd"> :type instance_id: str</span>
<span class="sd"> :param project_id: Optional, the ID of the GCP 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"> :return: None</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">instance</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_client</span><span class="p">(</span><span class="n">project_id</span><span class="o">=</span><span class="n">project_id</span><span class="p">)</span><span class="o">.</span><span class="n">instance</span><span class="p">(</span><span class="n">instance_id</span><span class="p">)</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">instance</span><span class="o">.</span><span class="n">delete</span><span class="p">()</span>
<span class="k">return</span>
<span class="k">except</span> <span class="n">GoogleAPICallError</span> <span class="k">as</span> <span class="n">e</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">error</span><span class="p">(</span><span class="s1">&#39;An error occurred: </span><span class="si">%s</span><span class="s1">. Exiting.&#39;</span><span class="p">,</span> <span class="n">e</span><span class="o">.</span><span class="n">message</span><span class="p">)</span>
<span class="k">raise</span> <span class="n">e</span></div>
<span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">fallback_to_default_project_id</span>
<div class="viewcode-block" id="CloudSpannerHook.get_database"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_spanner_hook/index.html#airflow.contrib.hooks.gcp_spanner_hook.CloudSpannerHook.get_database">[docs]</a> <span class="k">def</span> <span class="nf">get_database</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">instance_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="sd">&quot;&quot;&quot;</span>
<span class="sd"> Retrieves a database in Cloud Spanner. If the database does not exist</span>
<span class="sd"> in the specified instance, it returns None.</span>
<span class="sd"> :param instance_id: The ID of the Cloud Spanner instance.</span>
<span class="sd"> :type instance_id: str</span>
<span class="sd"> :param database_id: The ID of the database in Cloud Spanner.</span>
<span class="sd"> :type database_id: str</span>
<span class="sd"> :param project_id: Optional, the ID of the GCP 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"> :return: Database object or None if database does not exist</span>
<span class="sd"> :rtype: google.cloud.spanner_v1.database.Database or None</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">instance</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_client</span><span class="p">(</span><span class="n">project_id</span><span class="o">=</span><span class="n">project_id</span><span class="p">)</span><span class="o">.</span><span class="n">instance</span><span class="p">(</span>
<span class="n">instance_id</span><span class="o">=</span><span class="n">instance_id</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">instance</span><span class="o">.</span><span class="n">exists</span><span class="p">():</span>
<span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s2">&quot;The instance </span><span class="si">{}</span><span class="s2"> does not exist in project </span><span class="si">{}</span><span class="s2"> !&quot;</span><span class="o">.</span>
<span class="nb">format</span><span class="p">(</span><span class="n">instance_id</span><span class="p">,</span> <span class="n">project_id</span><span class="p">))</span>
<span class="n">database</span> <span class="o">=</span> <span class="n">instance</span><span class="o">.</span><span class="n">database</span><span class="p">(</span><span class="n">database_id</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">database</span><span class="o">.</span><span class="n">exists</span><span class="p">():</span>
<span class="k">return</span> <span class="kc">None</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="n">database</span></div>
<span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">fallback_to_default_project_id</span>
<div class="viewcode-block" id="CloudSpannerHook.create_database"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_spanner_hook/index.html#airflow.contrib.hooks.gcp_spanner_hook.CloudSpannerHook.create_database">[docs]</a> <span class="k">def</span> <span class="nf">create_database</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">instance_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="sd">&quot;&quot;&quot;</span>
<span class="sd"> Creates a new database in Cloud Spanner.</span>
<span class="sd"> :type project_id: str</span>
<span class="sd"> :param instance_id: The ID of the Cloud Spanner instance.</span>
<span class="sd"> :type instance_id: str</span>
<span class="sd"> :param database_id: The ID of the database to create in Cloud Spanner.</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 GCP 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"> :return: None</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">instance</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_client</span><span class="p">(</span><span class="n">project_id</span><span class="o">=</span><span class="n">project_id</span><span class="p">)</span><span class="o">.</span><span class="n">instance</span><span class="p">(</span>
<span class="n">instance_id</span><span class="o">=</span><span class="n">instance_id</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">instance</span><span class="o">.</span><span class="n">exists</span><span class="p">():</span>
<span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s2">&quot;The instance </span><span class="si">{}</span><span class="s2"> does not exist in project </span><span class="si">{}</span><span class="s2"> !&quot;</span><span class="o">.</span>
<span class="nb">format</span><span class="p">(</span><span class="n">instance_id</span><span class="p">,</span> <span class="n">project_id</span><span class="p">))</span>
<span class="n">database</span> <span class="o">=</span> <span class="n">instance</span><span class="o">.</span><span class="n">database</span><span class="p">(</span><span class="n">database_id</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="n">ddl_statements</span><span class="p">)</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">operation</span> <span class="o">=</span> <span class="n">database</span><span class="o">.</span><span class="n">create</span><span class="p">()</span> <span class="c1"># type: Operation</span>
<span class="k">except</span> <span class="n">GoogleAPICallError</span> <span class="k">as</span> <span class="n">e</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">error</span><span class="p">(</span><span class="s1">&#39;An error occurred: </span><span class="si">%s</span><span class="s1">. Exiting.&#39;</span><span class="p">,</span> <span class="n">e</span><span class="o">.</span><span class="n">message</span><span class="p">)</span>
<span class="k">raise</span> <span class="n">e</span>
<span class="k">if</span> <span class="n">operation</span><span class="p">:</span>
<span class="n">result</span> <span class="o">=</span> <span class="n">operation</span><span class="o">.</span><span class="n">result</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">result</span><span class="p">)</span>
<span class="k">return</span></div>
<span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">fallback_to_default_project_id</span>
<div class="viewcode-block" id="CloudSpannerHook.update_database"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_spanner_hook/index.html#airflow.contrib.hooks.gcp_spanner_hook.CloudSpannerHook.update_database">[docs]</a> <span class="k">def</span> <span class="nf">update_database</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="sd">&quot;&quot;&quot;</span>
<span class="sd"> Updates DDL of a database in Cloud Spanner.</span>
<span class="sd"> :type project_id: str</span>
<span class="sd"> :param instance_id: The ID of the Cloud Spanner instance.</span>
<span class="sd"> :type instance_id: str</span>
<span class="sd"> :param database_id: The ID of the database in Cloud Spanner.</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 GCP 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"> :param operation_id: (Optional) The unique per database operation ID that can be</span>
<span class="sd"> specified to implement idempotency check.</span>
<span class="sd"> :type operation_id: str</span>
<span class="sd"> :return: None</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">instance</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_client</span><span class="p">(</span><span class="n">project_id</span><span class="o">=</span><span class="n">project_id</span><span class="p">)</span><span class="o">.</span><span class="n">instance</span><span class="p">(</span>
<span class="n">instance_id</span><span class="o">=</span><span class="n">instance_id</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">instance</span><span class="o">.</span><span class="n">exists</span><span class="p">():</span>
<span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s2">&quot;The instance </span><span class="si">{}</span><span class="s2"> does not exist in project </span><span class="si">{}</span><span class="s2"> !&quot;</span><span class="o">.</span>
<span class="nb">format</span><span class="p">(</span><span class="n">instance_id</span><span class="p">,</span> <span class="n">project_id</span><span class="p">))</span>
<span class="n">database</span> <span class="o">=</span> <span class="n">instance</span><span class="o">.</span><span class="n">database</span><span class="p">(</span><span class="n">database_id</span><span class="o">=</span><span class="n">database_id</span><span class="p">)</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">operation</span> <span class="o">=</span> <span class="n">database</span><span class="o">.</span><span class="n">update_ddl</span><span class="p">(</span>
<span class="n">ddl_statements</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="n">operation_id</span><span class="p">)</span>
<span class="k">if</span> <span class="n">operation</span><span class="p">:</span>
<span class="n">result</span> <span class="o">=</span> <span class="n">operation</span><span class="o">.</span><span class="n">result</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">result</span><span class="p">)</span>
<span class="k">return</span>
<span class="k">except</span> <span class="n">AlreadyExists</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
<span class="k">if</span> <span class="n">e</span><span class="o">.</span><span class="n">code</span> <span class="o">==</span> <span class="mi">409</span> <span class="ow">and</span> <span class="n">operation_id</span> <span class="ow">in</span> <span class="n">e</span><span class="o">.</span><span class="n">message</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;Replayed update_ddl message - the operation id </span><span class="si">%s</span><span class="s2"> &quot;</span>
<span class="s2">&quot;was already done before.&quot;</span><span class="p">,</span> <span class="n">operation_id</span><span class="p">)</span>
<span class="k">return</span>
<span class="k">except</span> <span class="n">GoogleAPICallError</span> <span class="k">as</span> <span class="n">e</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">error</span><span class="p">(</span><span class="s1">&#39;An error occurred: </span><span class="si">%s</span><span class="s1">. Exiting.&#39;</span><span class="p">,</span> <span class="n">e</span><span class="o">.</span><span class="n">message</span><span class="p">)</span>
<span class="k">raise</span> <span class="n">e</span></div>
<span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">fallback_to_default_project_id</span>
<div class="viewcode-block" id="CloudSpannerHook.delete_database"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_spanner_hook/index.html#airflow.contrib.hooks.gcp_spanner_hook.CloudSpannerHook.delete_database">[docs]</a> <span class="k">def</span> <span class="nf">delete_database</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">instance_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="sd">&quot;&quot;&quot;</span>
<span class="sd"> Drops a database in Cloud Spanner.</span>
<span class="sd"> :type project_id: str</span>
<span class="sd"> :param instance_id: The ID of the Cloud Spanner instance.</span>
<span class="sd"> :type instance_id: str</span>
<span class="sd"> :param database_id: The ID of the database in Cloud Spanner.</span>
<span class="sd"> :type database_id: str</span>
<span class="sd"> :param project_id: Optional, the ID of the GCP 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"> :return: True if everything succeeded</span>
<span class="sd"> :rtype: bool</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">instance</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_client</span><span class="p">(</span><span class="n">project_id</span><span class="o">=</span><span class="n">project_id</span><span class="p">)</span><span class="o">.</span>\
<span class="n">instance</span><span class="p">(</span><span class="n">instance_id</span><span class="o">=</span><span class="n">instance_id</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">instance</span><span class="o">.</span><span class="n">exists</span><span class="p">():</span>
<span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s2">&quot;The instance </span><span class="si">{}</span><span class="s2"> does not exist in project </span><span class="si">{}</span><span class="s2"> !&quot;</span><span class="o">.</span>
<span class="nb">format</span><span class="p">(</span><span class="n">instance_id</span><span class="p">,</span> <span class="n">project_id</span><span class="p">))</span>
<span class="n">database</span> <span class="o">=</span> <span class="n">instance</span><span class="o">.</span><span class="n">database</span><span class="p">(</span><span class="n">database_id</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">database</span><span class="o">.</span><span class="n">exists</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 </span><span class="si">{}</span><span class="s2"> is already deleted from instance </span><span class="si">{}</span><span class="s2">. &quot;</span>
<span class="s2">&quot;Exiting.&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">database_id</span><span class="p">,</span> <span class="n">instance_id</span><span class="p">))</span>
<span class="k">return</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">operation</span> <span class="o">=</span> <span class="n">database</span><span class="o">.</span><span class="n">drop</span><span class="p">()</span> <span class="c1"># type: Operation</span>
<span class="k">except</span> <span class="n">GoogleAPICallError</span> <span class="k">as</span> <span class="n">e</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">error</span><span class="p">(</span><span class="s1">&#39;An error occurred: </span><span class="si">%s</span><span class="s1">. Exiting.&#39;</span><span class="p">,</span> <span class="n">e</span><span class="o">.</span><span class="n">message</span><span class="p">)</span>
<span class="k">raise</span> <span class="n">e</span>
<span class="k">if</span> <span class="n">operation</span><span class="p">:</span>
<span class="n">result</span> <span class="o">=</span> <span class="n">operation</span><span class="o">.</span><span class="n">result</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">result</span><span class="p">)</span>
<span class="k">return</span></div>
<span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">fallback_to_default_project_id</span>
<div class="viewcode-block" id="CloudSpannerHook.execute_dml"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_spanner_hook/index.html#airflow.contrib.hooks.gcp_spanner_hook.CloudSpannerHook.execute_dml">[docs]</a> <span class="k">def</span> <span class="nf">execute_dml</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">queries</span><span class="p">,</span> <span class="n">project_id</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Executes an arbitrary DML query (INSERT, UPDATE, DELETE).</span>
<span class="sd"> :param instance_id: The ID of the Cloud Spanner instance.</span>
<span class="sd"> :type instance_id: str</span>
<span class="sd"> :param database_id: The ID of the database in Cloud Spanner.</span>
<span class="sd"> :type database_id: str</span>
<span class="sd"> :param queries: The queries to execute.</span>
<span class="sd"> :type queries: str</span>
<span class="sd"> :param project_id: Optional, the ID of the GCP 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"> &quot;&quot;&quot;</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_get_client</span><span class="p">(</span><span class="n">project_id</span><span class="o">=</span><span class="n">project_id</span><span class="p">)</span><span class="o">.</span><span class="n">instance</span><span class="p">(</span><span class="n">instance_id</span><span class="o">=</span><span class="n">instance_id</span><span class="p">)</span><span class="o">.</span>\
<span class="n">database</span><span class="p">(</span><span class="n">database_id</span><span class="o">=</span><span class="n">database_id</span><span class="p">)</span><span class="o">.</span><span class="n">run_in_transaction</span><span class="p">(</span>
<span class="k">lambda</span> <span class="n">transaction</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">_execute_sql_in_transaction</span><span class="p">(</span><span class="n">transaction</span><span class="p">,</span> <span class="n">queries</span><span class="p">))</span></div>
<span class="nd">@staticmethod</span>
<div class="viewcode-block" id="CloudSpannerHook._execute_sql_in_transaction"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_spanner_hook/index.html#airflow.contrib.hooks.gcp_spanner_hook.CloudSpannerHook._execute_sql_in_transaction">[docs]</a> <span class="k">def</span> <span class="nf">_execute_sql_in_transaction</span><span class="p">(</span><span class="n">transaction</span><span class="p">,</span> <span class="n">queries</span><span class="p">):</span>
<span class="k">for</span> <span class="n">sql</span> <span class="ow">in</span> <span class="n">queries</span><span class="p">:</span>
<span class="n">transaction</span><span class="o">.</span><span class="n">execute_update</span><span class="p">(</span><span class="n">sql</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>