Google Git
Sign in
apache / airflow-site / f81e48aadee354653679693fa54b04ac42d24bfd / . / docs-archive / 1.10.3 / _modules / airflow / contrib / operators / gcp_bigtable_operator.html
blob: 5d9ed9b40a8610b56a9d7fd1f69c7dbdf2582cc5 [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_bigtable_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.3
</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_bigtable_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_bigtable_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">from</span> <span class="nn">typing</span> <span class="k">import</span> <span class="n">Iterable</span>
<span class="kn">import</span> <span class="nn">google.api_core.exceptions</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.models</span> <span class="k">import</span> <span class="n">BaseOperator</span>
<span class="kn">from</span> <span class="nn">airflow.sensors.base_sensor_operator</span> <span class="k">import</span> <span class="n">BaseSensorOperator</span>
<span class="kn">from</span> <span class="nn">airflow.contrib.hooks.gcp_bigtable_hook</span> <span class="k">import</span> <span class="n">BigtableHook</span>
<span class="kn">from</span> <span class="nn">airflow.utils.decorators</span> <span class="k">import</span> <span class="n">apply_defaults</span>
<span class="kn">from</span> <span class="nn">google.cloud.bigtable_admin_v2</span> <span class="k">import</span> <span class="n">enums</span>
<span class="kn">from</span> <span class="nn">google.cloud.bigtable.table</span> <span class="k">import</span> <span class="n">ClusterState</span>
<div class="viewcode-block" id="BigtableValidationMixin"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_bigtable_operator/index.html#airflow.contrib.operators.gcp_bigtable_operator.BigtableValidationMixin">[docs]</a><span class="k">class</span> <span class="nc">BigtableValidationMixin</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Common class for Cloud Bigtable operators for validating required fields.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<div class="viewcode-block" id="BigtableValidationMixin.REQUIRED_ATTRIBUTES"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_bigtable_operator/index.html#airflow.contrib.operators.gcp_bigtable_operator.BigtableValidationMixin.REQUIRED_ATTRIBUTES">[docs]</a> <span class="n">REQUIRED_ATTRIBUTES</span> <span class="o">=</span> <span class="p">[]</span> <span class="c1"># type: Iterable[str]</span></div>
<div class="viewcode-block" id="BigtableValidationMixin._validate_inputs"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_bigtable_operator/index.html#airflow.contrib.operators.gcp_bigtable_operator.BigtableValidationMixin._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">for</span> <span class="n">attr_name</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">REQUIRED_ATTRIBUTES</span><span class="p">:</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">attr_name</span><span class="p">):</span>
<span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s1">&#39;Empty parameter: </span><span class="si">{}</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">attr_name</span><span class="p">))</span></div></div>
<div class="viewcode-block" id="BigtableInstanceCreateOperator"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_bigtable_operator/index.html#airflow.contrib.operators.gcp_bigtable_operator.BigtableInstanceCreateOperator">[docs]</a><span class="k">class</span> <span class="nc">BigtableInstanceCreateOperator</span><span class="p">(</span><span class="n">BaseOperator</span><span class="p">,</span> <span class="n">BigtableValidationMixin</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Creates a new Cloud Bigtable instance.</span>
<span class="sd"> If the Cloud Bigtable instance with the given ID exists, the operator does not</span>
<span class="sd"> compare its configuration</span>
<span class="sd"> and immediately succeeds. No changes are made to the existing instance.</span>
<span class="sd"> For more details about instance creation have a look at the reference:</span>
<span class="sd"> https://googleapis.github.io/google-cloud-python/latest/bigtable/instance.html#google.cloud.bigtable.instance.Instance.create</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:BigtableInstanceCreateOperator`</span>
<span class="sd"> :type instance_id: str</span>
<span class="sd"> :param instance_id: The ID of the Cloud Bigtable instance to create.</span>
<span class="sd"> :type main_cluster_id: str</span>
<span class="sd"> :param main_cluster_id: The ID for main cluster for the new instance.</span>
<span class="sd"> :type main_cluster_zone: str</span>
<span class="sd"> :param main_cluster_zone: The zone for main cluster</span>
<span class="sd"> See https://cloud.google.com/bigtable/docs/locations for more details.</span>
<span class="sd"> :type project_id: str</span>
<span class="sd"> :param project_id: Optional, the ID of the GCP project. If set to None or missing,</span>
<span class="sd"> the default project_id from the GCP connection is used.</span>
<span class="sd"> :type replica_cluster_id: str</span>
<span class="sd"> :param replica_cluster_id: (optional) The ID for replica cluster for the new instance.</span>
<span class="sd"> :type replica_cluster_zone: str</span>
<span class="sd"> :param replica_cluster_zone: (optional) The zone for replica cluster.</span>
<span class="sd"> :type instance_type: enums.IntEnum</span>
<span class="sd"> :param instance_type: (optional) The type of the instance.</span>
<span class="sd"> :type instance_display_name: str</span>
<span class="sd"> :param instance_display_name: (optional) Human-readable name of the instance. Defaults</span>
<span class="sd"> to ``instance_id``.</span>
<span class="sd"> :type instance_labels: dict</span>
<span class="sd"> :param instance_labels: (optional) Dictionary of labels to associate</span>
<span class="sd"> with the instance.</span>
<span class="sd"> :type cluster_nodes: int</span>
<span class="sd"> :param cluster_nodes: (optional) Number of nodes for cluster.</span>
<span class="sd"> :type cluster_storage_type: enums.IntEnum</span>
<span class="sd"> :param cluster_storage_type: (optional) The type of storage.</span>
<span class="sd"> :type timeout: int</span>
<span class="sd"> :param timeout: (optional) timeout (in seconds) for instance creation.</span>
<span class="sd"> If None is not specified, Operator will wait indefinitely.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<div class="viewcode-block" id="BigtableInstanceCreateOperator.REQUIRED_ATTRIBUTES"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_bigtable_operator/index.html#airflow.contrib.operators.gcp_bigtable_operator.BigtableInstanceCreateOperator.REQUIRED_ATTRIBUTES">[docs]</a> <span class="n">REQUIRED_ATTRIBUTES</span> <span class="o">=</span> <span class="p">(</span><span class="s1">&#39;instance_id&#39;</span><span class="p">,</span> <span class="s1">&#39;main_cluster_id&#39;</span><span class="p">,</span>
<span class="s1">&#39;main_cluster_zone&#39;</span><span class="p">)</span></div>
<div class="viewcode-block" id="BigtableInstanceCreateOperator.template_fields"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_bigtable_operator/index.html#airflow.contrib.operators.gcp_bigtable_operator.BigtableInstanceCreateOperator.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;main_cluster_id&#39;</span><span class="p">,</span>
<span class="s1">&#39;main_cluster_zone&#39;</span><span class="p">]</span></div>
<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">main_cluster_id</span><span class="p">,</span>
<span class="n">main_cluster_zone</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">replica_cluster_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">replica_cluster_zone</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">instance_display_name</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">instance_type</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">instance_labels</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">cluster_nodes</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">cluster_storage_type</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">timeout</span><span class="o">=</span><span class="kc">None</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">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">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">main_cluster_id</span> <span class="o">=</span> <span class="n">main_cluster_id</span>
<span class="bp">self</span><span class="o">.</span><span class="n">main_cluster_zone</span> <span class="o">=</span> <span class="n">main_cluster_zone</span>
<span class="bp">self</span><span class="o">.</span><span class="n">replica_cluster_id</span> <span class="o">=</span> <span class="n">replica_cluster_id</span>
<span class="bp">self</span><span class="o">.</span><span class="n">replica_cluster_zone</span> <span class="o">=</span> <span class="n">replica_cluster_zone</span>
<span class="bp">self</span><span class="o">.</span><span class="n">instance_display_name</span> <span class="o">=</span> <span class="n">instance_display_name</span>
<span class="bp">self</span><span class="o">.</span><span class="n">instance_type</span> <span class="o">=</span> <span class="n">instance_type</span>
<span class="bp">self</span><span class="o">.</span><span class="n">instance_labels</span> <span class="o">=</span> <span class="n">instance_labels</span>
<span class="bp">self</span><span class="o">.</span><span class="n">cluster_nodes</span> <span class="o">=</span> <span class="n">cluster_nodes</span>
<span class="bp">self</span><span class="o">.</span><span class="n">cluster_storage_type</span> <span class="o">=</span> <span class="n">cluster_storage_type</span>
<span class="bp">self</span><span class="o">.</span><span class="n">timeout</span> <span class="o">=</span> <span class="n">timeout</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">BigtableHook</span><span class="p">()</span>
<span class="nb">super</span><span class="p">(</span><span class="n">BigtableInstanceCreateOperator</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="BigtableInstanceCreateOperator.execute"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_bigtable_operator/index.html#airflow.contrib.operators.gcp_bigtable_operator.BigtableInstanceCreateOperator.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">instance</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_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">if</span> <span class="n">instance</span><span class="p">:</span>
<span class="c1"># Based on Instance.__eq__ instance with the same ID and client is</span>
<span class="c1"># considered as equal.</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 instance &#39;</span><span class="si">%s</span><span class="s2">&#39; already exists in this project. &quot;</span>
<span class="s2">&quot;Consider it as created&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="k">return</span>
<span class="k">try</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">create_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="n">main_cluster_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">main_cluster_id</span><span class="p">,</span>
<span class="n">main_cluster_zone</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">main_cluster_zone</span><span class="p">,</span>
<span class="n">replica_cluster_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">replica_cluster_id</span><span class="p">,</span>
<span class="n">replica_cluster_zone</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">replica_cluster_zone</span><span class="p">,</span>
<span class="n">instance_display_name</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">instance_display_name</span><span class="p">,</span>
<span class="n">instance_type</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">instance_type</span><span class="p">,</span>
<span class="n">instance_labels</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">instance_labels</span><span class="p">,</span>
<span class="n">cluster_nodes</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">cluster_nodes</span><span class="p">,</span>
<span class="n">cluster_storage_type</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">cluster_storage_type</span><span class="p">,</span>
<span class="n">timeout</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">timeout</span><span class="p">,</span>
<span class="p">)</span>
<span class="k">except</span> <span class="n">google</span><span class="o">.</span><span class="n">api_core</span><span class="o">.</span><span class="n">exceptions</span><span class="o">.</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. Exiting.&#39;</span><span class="p">)</span>
<span class="k">raise</span> <span class="n">e</span></div></div>
<div class="viewcode-block" id="BigtableInstanceDeleteOperator"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_bigtable_operator/index.html#airflow.contrib.operators.gcp_bigtable_operator.BigtableInstanceDeleteOperator">[docs]</a><span class="k">class</span> <span class="nc">BigtableInstanceDeleteOperator</span><span class="p">(</span><span class="n">BaseOperator</span><span class="p">,</span> <span class="n">BigtableValidationMixin</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Deletes the Cloud Bigtable instance, including its clusters and all related tables.</span>
<span class="sd"> For more details about deleting instance have a look at the reference:</span>
<span class="sd"> https://googleapis.github.io/google-cloud-python/latest/bigtable/instance.html#google.cloud.bigtable.instance.Instance.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:BigtableInstanceDeleteOperator`</span>
<span class="sd"> :type instance_id: str</span>
<span class="sd"> :param instance_id: The ID of the Cloud Bigtable instance to delete.</span>
<span class="sd"> :param project_id: Optional, the ID of the GCP project. If set to None or missing,</span>
<span class="sd"> 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>
<div class="viewcode-block" id="BigtableInstanceDeleteOperator.REQUIRED_ATTRIBUTES"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_bigtable_operator/index.html#airflow.contrib.operators.gcp_bigtable_operator.BigtableInstanceDeleteOperator.REQUIRED_ATTRIBUTES">[docs]</a> <span class="n">REQUIRED_ATTRIBUTES</span> <span class="o">=</span> <span class="p">(</span><span class="s1">&#39;instance_id&#39;</span><span class="p">,)</span></div>
<div class="viewcode-block" id="BigtableInstanceDeleteOperator.template_fields"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_bigtable_operator/index.html#airflow.contrib.operators.gcp_bigtable_operator.BigtableInstanceDeleteOperator.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></div>
<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="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">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">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">_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">BigtableHook</span><span class="p">()</span>
<span class="nb">super</span><span class="p">(</span><span class="n">BigtableInstanceDeleteOperator</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="BigtableInstanceDeleteOperator.execute"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_bigtable_operator/index.html#airflow.contrib.operators.gcp_bigtable_operator.BigtableInstanceDeleteOperator.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">try</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">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">except</span> <span class="n">google</span><span class="o">.</span><span class="n">api_core</span><span class="o">.</span><span class="n">exceptions</span><span class="o">.</span><span class="n">NotFound</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 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;Consider it as deleted&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">except</span> <span class="n">google</span><span class="o">.</span><span class="n">api_core</span><span class="o">.</span><span class="n">exceptions</span><span class="o">.</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. Exiting.&#39;</span><span class="p">)</span>
<span class="k">raise</span> <span class="n">e</span></div></div>
<div class="viewcode-block" id="BigtableTableCreateOperator"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_bigtable_operator/index.html#airflow.contrib.operators.gcp_bigtable_operator.BigtableTableCreateOperator">[docs]</a><span class="k">class</span> <span class="nc">BigtableTableCreateOperator</span><span class="p">(</span><span class="n">BaseOperator</span><span class="p">,</span> <span class="n">BigtableValidationMixin</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Creates the table in the Cloud Bigtable instance.</span>
<span class="sd"> For more details about creating table have a look at the reference:</span>
<span class="sd"> https://googleapis.github.io/google-cloud-python/latest/bigtable/table.html#google.cloud.bigtable.table.Table.create</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:BigtableTableCreateOperator`</span>
<span class="sd"> :type instance_id: str</span>
<span class="sd"> :param instance_id: The ID of the Cloud Bigtable instance that will</span>
<span class="sd"> hold the new table.</span>
<span class="sd"> :type table_id: str</span>
<span class="sd"> :param table_id: The ID of the table to be created.</span>
<span class="sd"> :type project_id: str</span>
<span class="sd"> :param project_id: Optional, the ID of the GCP project. If set to None or missing,</span>
<span class="sd"> the default project_id from the GCP connection is used.</span>
<span class="sd"> :type initial_split_keys: list</span>
<span class="sd"> :param initial_split_keys: (Optional) list of row keys in bytes that will be used to</span>
<span class="sd"> initially split the table into several tablets.</span>
<span class="sd"> :type column_families: dict</span>
<span class="sd"> :param column_families: (Optional) A map columns to create.</span>
<span class="sd"> The key is the column_id str and the value is a</span>
<span class="sd"> :class:`google.cloud.bigtable.column_family.GarbageCollectionRule`</span>
<span class="sd"> &quot;&quot;&quot;</span>
<div class="viewcode-block" id="BigtableTableCreateOperator.REQUIRED_ATTRIBUTES"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_bigtable_operator/index.html#airflow.contrib.operators.gcp_bigtable_operator.BigtableTableCreateOperator.REQUIRED_ATTRIBUTES">[docs]</a> <span class="n">REQUIRED_ATTRIBUTES</span> <span class="o">=</span> <span class="p">(</span><span class="s1">&#39;instance_id&#39;</span><span class="p">,</span> <span class="s1">&#39;table_id&#39;</span><span class="p">)</span></div>
<div class="viewcode-block" id="BigtableTableCreateOperator.template_fields"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_bigtable_operator/index.html#airflow.contrib.operators.gcp_bigtable_operator.BigtableTableCreateOperator.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;table_id&#39;</span><span class="p">]</span></div>
<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">table_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">initial_split_keys</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">column_families</span><span class="o">=</span><span class="kc">None</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">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">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">table_id</span> <span class="o">=</span> <span class="n">table_id</span>
<span class="bp">self</span><span class="o">.</span><span class="n">initial_split_keys</span> <span class="o">=</span> <span class="n">initial_split_keys</span> <span class="ow">or</span> <span class="nb">list</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">column_families</span> <span class="o">=</span> <span class="n">column_families</span> <span class="ow">or</span> <span class="nb">dict</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_validate_inputs</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">hook</span> <span class="o">=</span> <span class="n">BigtableHook</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">instance</span> <span class="o">=</span> <span class="kc">None</span>
<span class="nb">super</span><span class="p">(</span><span class="n">BigtableTableCreateOperator</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="BigtableTableCreateOperator._compare_column_families"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_bigtable_operator/index.html#airflow.contrib.operators.gcp_bigtable_operator.BigtableTableCreateOperator._compare_column_families">[docs]</a> <span class="k">def</span> <span class="nf">_compare_column_families</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="n">table_column_families</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_column_families_for_table</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">instance</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">table_id</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">set</span><span class="p">(</span><span class="n">table_column_families</span><span class="o">.</span><span class="n">keys</span><span class="p">())</span> <span class="o">!=</span> <span class="nb">set</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">column_families</span><span class="o">.</span><span class="n">keys</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="s2">&quot;Table &#39;</span><span class="si">%s</span><span class="s2">&#39; has different set of Column Families&quot;</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">table_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">error</span><span class="p">(</span><span class="s2">&quot;Expected: </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">column_families</span><span class="o">.</span><span class="n">keys</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="s2">&quot;Actual: </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="n">table_column_families</span><span class="o">.</span><span class="n">keys</span><span class="p">())</span>
<span class="k">return</span> <span class="kc">False</span>
<span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="n">table_column_families</span><span class="o">.</span><span class="n">keys</span><span class="p">():</span>
<span class="c1"># There is difference in structure between local Column Families</span>
<span class="c1"># and remote ones</span>
<span class="c1"># Local `self.column_families` is dict with column_id as key</span>
<span class="c1"># and GarbageCollectionRule as value.</span>
<span class="c1"># Remote `table_column_families` is list of ColumnFamily objects.</span>
<span class="c1"># For more information about ColumnFamily please refer to the documentation:</span>
<span class="c1"># https://googleapis.github.io/google-cloud-python/latest/bigtable/column-family.html#google.cloud.bigtable.column_family.ColumnFamily</span>
<span class="k">if</span> <span class="n">table_column_families</span><span class="p">[</span><span class="n">key</span><span class="p">]</span><span class="o">.</span><span class="n">gc_rule</span> <span class="o">!=</span> <span class="bp">self</span><span class="o">.</span><span class="n">column_families</span><span class="p">[</span><span class="n">key</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="s2">&quot;Column Family &#39;</span><span class="si">%s</span><span class="s2">&#39; differs for table &#39;</span><span class="si">%s</span><span class="s2">&#39;.&quot;</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">table_id</span><span class="p">)</span>
<span class="k">return</span> <span class="kc">False</span>
<span class="k">return</span> <span class="kc">True</span></div>
<div class="viewcode-block" id="BigtableTableCreateOperator.execute"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_bigtable_operator/index.html#airflow.contrib.operators.gcp_bigtable_operator.BigtableTableCreateOperator.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="bp">self</span><span class="o">.</span><span class="n">instance</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">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">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">instance</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span>
<span class="s2">&quot;Dependency: instance &#39;</span><span class="si">{}</span><span class="s2">&#39; does not exist in project &#39;</span><span class="si">{}</span><span class="s2">&#39;.&quot;</span><span class="o">.</span>
<span class="nb">format</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">try</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">create_table</span><span class="p">(</span>
<span class="n">instance</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">instance</span><span class="p">,</span>
<span class="n">table_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">table_id</span><span class="p">,</span>
<span class="n">initial_split_keys</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">initial_split_keys</span><span class="p">,</span>
<span class="n">column_families</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">column_families</span>
<span class="p">)</span>
<span class="k">except</span> <span class="n">google</span><span class="o">.</span><span class="n">api_core</span><span class="o">.</span><span class="n">exceptions</span><span class="o">.</span><span class="n">AlreadyExists</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">_compare_column_families</span><span class="p">():</span>
<span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span>
<span class="s2">&quot;Table &#39;</span><span class="si">{}</span><span class="s2">&#39; already exists with different Column Families.&quot;</span><span class="o">.</span>
<span class="nb">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">table_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;The table &#39;</span><span class="si">%s</span><span class="s2">&#39; already exists. Consider it as created&quot;</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">table_id</span><span class="p">)</span></div></div>
<div class="viewcode-block" id="BigtableTableDeleteOperator"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_bigtable_operator/index.html#airflow.contrib.operators.gcp_bigtable_operator.BigtableTableDeleteOperator">[docs]</a><span class="k">class</span> <span class="nc">BigtableTableDeleteOperator</span><span class="p">(</span><span class="n">BaseOperator</span><span class="p">,</span> <span class="n">BigtableValidationMixin</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Deletes the Cloud Bigtable table.</span>
<span class="sd"> For more details about deleting table have a look at the reference:</span>
<span class="sd"> https://googleapis.github.io/google-cloud-python/latest/bigtable/table.html#google.cloud.bigtable.table.Table.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:BigtableTableDeleteOperator`</span>
<span class="sd"> :type instance_id: str</span>
<span class="sd"> :param instance_id: The ID of the Cloud Bigtable instance.</span>
<span class="sd"> :type table_id: str</span>
<span class="sd"> :param table_id: The ID of the table to be deleted.</span>
<span class="sd"> :type project_id: str</span>
<span class="sd"> :param project_id: Optional, the ID of the GCP project. If set to None or missing,</span>
<span class="sd"> the default project_id from the GCP connection is used.</span>
<span class="sd"> :type app_profile_id: str</span>
<span class="sd"> :parm app_profile_id: Application profile.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<div class="viewcode-block" id="BigtableTableDeleteOperator.REQUIRED_ATTRIBUTES"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_bigtable_operator/index.html#airflow.contrib.operators.gcp_bigtable_operator.BigtableTableDeleteOperator.REQUIRED_ATTRIBUTES">[docs]</a> <span class="n">REQUIRED_ATTRIBUTES</span> <span class="o">=</span> <span class="p">(</span><span class="s1">&#39;instance_id&#39;</span><span class="p">,</span> <span class="s1">&#39;table_id&#39;</span><span class="p">)</span></div>
<div class="viewcode-block" id="BigtableTableDeleteOperator.template_fields"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_bigtable_operator/index.html#airflow.contrib.operators.gcp_bigtable_operator.BigtableTableDeleteOperator.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;table_id&#39;</span><span class="p">]</span></div>
<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">table_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">app_profile_id</span><span class="o">=</span><span class="kc">None</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">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">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">table_id</span> <span class="o">=</span> <span class="n">table_id</span>
<span class="bp">self</span><span class="o">.</span><span class="n">app_profile_id</span> <span class="o">=</span> <span class="n">app_profile_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">BigtableHook</span><span class="p">()</span>
<span class="nb">super</span><span class="p">(</span><span class="n">BigtableTableDeleteOperator</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="BigtableTableDeleteOperator.execute"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_bigtable_operator/index.html#airflow.contrib.operators.gcp_bigtable_operator.BigtableTableDeleteOperator.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">instance</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_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">if</span> <span class="ow">not</span> <span class="n">instance</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s2">&quot;Dependency: instance &#39;</span><span class="si">{}</span><span class="s2">&#39; does not exist.&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">instance_id</span><span class="p">))</span>
<span class="k">try</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">hook</span><span class="o">.</span><span class="n">delete_table</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">table_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">table_id</span><span class="p">,</span>
<span class="p">)</span>
<span class="k">except</span> <span class="n">google</span><span class="o">.</span><span class="n">api_core</span><span class="o">.</span><span class="n">exceptions</span><span class="o">.</span><span class="n">NotFound</span><span class="p">:</span>
<span class="c1"># It&#39;s OK if table doesn&#39;t exists.</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 table &#39;</span><span class="si">%s</span><span class="s2">&#39; no longer exists. Consider it as deleted&quot;</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">table_id</span><span class="p">)</span>
<span class="k">except</span> <span class="n">google</span><span class="o">.</span><span class="n">api_core</span><span class="o">.</span><span class="n">exceptions</span><span class="o">.</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. Exiting.&#39;</span><span class="p">)</span>
<span class="k">raise</span> <span class="n">e</span></div></div>
<div class="viewcode-block" id="BigtableClusterUpdateOperator"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_bigtable_operator/index.html#airflow.contrib.operators.gcp_bigtable_operator.BigtableClusterUpdateOperator">[docs]</a><span class="k">class</span> <span class="nc">BigtableClusterUpdateOperator</span><span class="p">(</span><span class="n">BaseOperator</span><span class="p">,</span> <span class="n">BigtableValidationMixin</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Updates a Cloud Bigtable cluster.</span>
<span class="sd"> For more details about updating a Cloud Bigtable cluster,</span>
<span class="sd"> have a look at the reference:</span>
<span class="sd"> https://googleapis.github.io/google-cloud-python/latest/bigtable/cluster.html#google.cloud.bigtable.cluster.Cluster.update</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:BigtableClusterUpdateOperator`</span>
<span class="sd"> :type instance_id: str</span>
<span class="sd"> :param instance_id: The ID of the Cloud Bigtable instance.</span>
<span class="sd"> :type cluster_id: str</span>
<span class="sd"> :param cluster_id: The ID of the Cloud Bigtable cluster to update.</span>
<span class="sd"> :type nodes: int</span>
<span class="sd"> :param nodes: The desired number of nodes for the Cloud Bigtable cluster.</span>
<span class="sd"> :type project_id: str</span>
<span class="sd"> :param project_id: Optional, the ID of the GCP project.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<div class="viewcode-block" id="BigtableClusterUpdateOperator.REQUIRED_ATTRIBUTES"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_bigtable_operator/index.html#airflow.contrib.operators.gcp_bigtable_operator.BigtableClusterUpdateOperator.REQUIRED_ATTRIBUTES">[docs]</a> <span class="n">REQUIRED_ATTRIBUTES</span> <span class="o">=</span> <span class="p">(</span><span class="s1">&#39;instance_id&#39;</span><span class="p">,</span> <span class="s1">&#39;cluster_id&#39;</span><span class="p">,</span> <span class="s1">&#39;nodes&#39;</span><span class="p">)</span></div>
<div class="viewcode-block" id="BigtableClusterUpdateOperator.template_fields"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_bigtable_operator/index.html#airflow.contrib.operators.gcp_bigtable_operator.BigtableClusterUpdateOperator.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;cluster_id&#39;</span><span class="p">,</span> <span class="s1">&#39;nodes&#39;</span><span class="p">]</span></div>
<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">cluster_id</span><span class="p">,</span>
<span class="n">nodes</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="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">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">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">cluster_id</span> <span class="o">=</span> <span class="n">cluster_id</span>
<span class="bp">self</span><span class="o">.</span><span class="n">nodes</span> <span class="o">=</span> <span class="n">nodes</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">BigtableHook</span><span class="p">()</span>
<span class="nb">super</span><span class="p">(</span><span class="n">BigtableClusterUpdateOperator</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="BigtableClusterUpdateOperator.execute"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_bigtable_operator/index.html#airflow.contrib.operators.gcp_bigtable_operator.BigtableClusterUpdateOperator.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">instance</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_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">if</span> <span class="ow">not</span> <span class="n">instance</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s2">&quot;Dependency: instance &#39;</span><span class="si">{}</span><span class="s2">&#39; does not exist.&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">instance_id</span><span class="p">))</span>
<span class="k">try</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">hook</span><span class="o">.</span><span class="n">update_cluster</span><span class="p">(</span>
<span class="n">instance</span><span class="o">=</span><span class="n">instance</span><span class="p">,</span>
<span class="n">cluster_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">cluster_id</span><span class="p">,</span>
<span class="n">nodes</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">nodes</span>
<span class="p">)</span>
<span class="k">except</span> <span class="n">google</span><span class="o">.</span><span class="n">api_core</span><span class="o">.</span><span class="n">exceptions</span><span class="o">.</span><span class="n">NotFound</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span>
<span class="s2">&quot;Dependency: cluster &#39;</span><span class="si">{}</span><span class="s2">&#39; does not exist for instance &#39;</span><span class="si">{}</span><span class="s2">&#39;.&quot;</span><span class="o">.</span>
<span class="nb">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">cluster_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">except</span> <span class="n">google</span><span class="o">.</span><span class="n">api_core</span><span class="o">.</span><span class="n">exceptions</span><span class="o">.</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. Exiting.&#39;</span><span class="p">)</span>
<span class="k">raise</span> <span class="n">e</span></div></div>
<div class="viewcode-block" id="BigtableTableWaitForReplicationSensor"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_bigtable_operator/index.html#airflow.contrib.operators.gcp_bigtable_operator.BigtableTableWaitForReplicationSensor">[docs]</a><span class="k">class</span> <span class="nc">BigtableTableWaitForReplicationSensor</span><span class="p">(</span><span class="n">BaseSensorOperator</span><span class="p">,</span> <span class="n">BigtableValidationMixin</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Sensor that waits for Cloud Bigtable table to be fully replicated to its clusters.</span>
<span class="sd"> No exception will be raised if the instance or the table does not exist.</span>
<span class="sd"> For more details about cluster states for a table, have a look at the reference:</span>
<span class="sd"> https://googleapis.github.io/google-cloud-python/latest/bigtable/table.html#google.cloud.bigtable.table.Table.get_cluster_states</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:BigtableTableWaitForReplicationSensor`</span>
<span class="sd"> :type instance_id: str</span>
<span class="sd"> :param instance_id: The ID of the Cloud Bigtable instance.</span>
<span class="sd"> :type table_id: str</span>
<span class="sd"> :param table_id: The ID of the table to check replication status.</span>
<span class="sd"> :type project_id: str</span>
<span class="sd"> :param project_id: Optional, the ID of the GCP project.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<div class="viewcode-block" id="BigtableTableWaitForReplicationSensor.REQUIRED_ATTRIBUTES"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_bigtable_operator/index.html#airflow.contrib.operators.gcp_bigtable_operator.BigtableTableWaitForReplicationSensor.REQUIRED_ATTRIBUTES">[docs]</a> <span class="n">REQUIRED_ATTRIBUTES</span> <span class="o">=</span> <span class="p">(</span><span class="s1">&#39;instance_id&#39;</span><span class="p">,</span> <span class="s1">&#39;table_id&#39;</span><span class="p">)</span></div>
<div class="viewcode-block" id="BigtableTableWaitForReplicationSensor.template_fields"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_bigtable_operator/index.html#airflow.contrib.operators.gcp_bigtable_operator.BigtableTableWaitForReplicationSensor.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;table_id&#39;</span><span class="p">]</span></div>
<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">table_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="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">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">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">table_id</span> <span class="o">=</span> <span class="n">table_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">BigtableHook</span><span class="p">()</span>
<span class="nb">super</span><span class="p">(</span><span class="n">BigtableTableWaitForReplicationSensor</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="BigtableTableWaitForReplicationSensor.poke"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_bigtable_operator/index.html#airflow.contrib.operators.gcp_bigtable_operator.BigtableTableWaitForReplicationSensor.poke">[docs]</a> <span class="k">def</span> <span class="nf">poke</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">instance</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_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">if</span> <span class="ow">not</span> <span class="n">instance</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;Dependency: instance &#39;</span><span class="si">%s</span><span class="s2">&#39; does not exist.&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="k">return</span> <span class="kc">False</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">cluster_states</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_cluster_states_for_table</span><span class="p">(</span><span class="n">instance</span><span class="o">=</span><span class="n">instance</span><span class="p">,</span>
<span class="n">table_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">table_id</span><span class="p">)</span>
<span class="k">except</span> <span class="n">google</span><span class="o">.</span><span class="n">api_core</span><span class="o">.</span><span class="n">exceptions</span><span class="o">.</span><span class="n">NotFound</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;Dependency: table &#39;</span><span class="si">%s</span><span class="s2">&#39; does not exist in 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">table_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">False</span>
<span class="n">ready_state</span> <span class="o">=</span> <span class="n">ClusterState</span><span class="p">(</span><span class="n">enums</span><span class="o">.</span><span class="n">Table</span><span class="o">.</span><span class="n">ClusterState</span><span class="o">.</span><span class="n">ReplicationState</span><span class="o">.</span><span class="n">READY</span><span class="p">)</span>
<span class="n">is_table_replicated</span> <span class="o">=</span> <span class="kc">True</span>
<span class="k">for</span> <span class="n">cluster_id</span> <span class="ow">in</span> <span class="n">cluster_states</span><span class="o">.</span><span class="n">keys</span><span class="p">():</span>
<span class="k">if</span> <span class="n">cluster_states</span><span class="p">[</span><span class="n">cluster_id</span><span class="p">]</span> <span class="o">!=</span> <span class="n">ready_state</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;Table &#39;</span><span class="si">%s</span><span class="s2">&#39; is not yet replicated on cluster &#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">table_id</span><span class="p">,</span> <span class="n">cluster_id</span><span class="p">)</span>
<span class="n">is_table_replicated</span> <span class="o">=</span> <span class="kc">False</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">is_table_replicated</span><span class="p">:</span>
<span class="k">return</span> <span class="kc">False</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;Table &#39;</span><span class="si">%s</span><span class="s2">&#39; is replicated.&quot;</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">table_id</span><span class="p">)</span>
<span class="k">return</span> <span class="kc">True</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>