| |
| |
| |
| |
| |
| <!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_bigtable_hook — Airflow Documentation</title> |
| |
| |
| |
| |
| |
| |
| |
| |
| <script type="text/javascript" src="../../../../_static/js/modernizr.min.js"></script> |
| |
| |
| <script type="text/javascript" id="documentation_options" data-url_root="../../../../" src="../../../../_static/documentation_options.js"></script> |
| <script type="text/javascript" src="../../../../_static/jquery.js"></script> |
| <script type="text/javascript" src="../../../../_static/underscore.js"></script> |
| <script type="text/javascript" src="../../../../_static/doctools.js"></script> |
| <script type="text/javascript" src="../../../../_static/language_data.js"></script> |
| |
| <script type="text/javascript" src="../../../../_static/js/theme.js"></script> |
| |
| |
| |
| |
| <link rel="stylesheet" href="../../../../_static/css/theme.css" type="text/css" /> |
| <link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" /> |
| <link rel="index" title="Index" href="../../../../genindex.html" /> |
| <link rel="search" title="Search" href="../../../../search.html" /> |
| |
| <script> |
| document.addEventListener('DOMContentLoaded', function() { |
| var el = document.getElementById('changelog'); |
| if (el !== null ) { |
| // [AIRFLOW-...] |
| el.innerHTML = el.innerHTML.replace( |
| /\[(AIRFLOW-[\d]+)\]/g, |
| `<a href="https://issues.apache.org/jira/browse/$1">[$1]</a>` |
| ); |
| // (#...) |
| el.innerHTML = el.innerHTML.replace( |
| /\(#([\d]+)\)/g, |
| `<a href="https://github.com/apache/airflow/pull/$1">(#$1)</a>` |
| ); |
| }; |
| }) |
| </script> |
| <script type="text/javascript"> |
| var _gaq = _gaq || []; |
| _gaq.push(['_setAccount', 'UA-140539454-1']); |
| _gaq.push(['_trackPageview']); |
| </script> |
| <style> |
| .example-header { |
| position: relative; |
| background: #9AAA7A; |
| padding: 8px 16px; |
| margin-bottom: 0; |
| } |
| .example-header--with-button { |
| padding-right: 166px; |
| } |
| .example-header:after{ |
| content: ''; |
| display: table; |
| clear: both; |
| } |
| .example-title { |
| display:block; |
| padding: 4px; |
| margin-right: 16px; |
| color: white; |
| overflow-x: auto; |
| } |
| .example-header-button { |
| top: 8px; |
| right: 16px; |
| position: absolute; |
| } |
| .example-header + .highlight-python { |
| margin-top: 0 !important; |
| } |
| .viewcode-button { |
| display: inline-block; |
| padding: 8px 16px; |
| border: 0; |
| margin: 0; |
| outline: 0; |
| border-radius: 2px; |
| -webkit-box-shadow: 0 3px 5px 0 rgba(0,0,0,.3); |
| box-shadow: 0 3px 6px 0 rgba(0,0,0,.3); |
| color: #404040; |
| background-color: #e7e7e7; |
| cursor: pointer; |
| font-size: 16px; |
| font-weight: 500; |
| line-height: 1; |
| text-decoration: none; |
| text-overflow: ellipsis; |
| overflow: hidden; |
| text-transform: uppercase; |
| -webkit-transition: background-color .2s; |
| transition: background-color .2s; |
| vertical-align: middle; |
| white-space: nowrap; |
| } |
| .viewcode-button:visited { |
| color: #404040; |
| } |
| .viewcode-button:hover, .viewcode-button:focus { |
| color: #404040; |
| background-color: #d6d6d6; |
| } |
| </style> |
| |
| </head> |
| |
| <body class="wy-body-for-nav"> |
| |
| |
| <div class="wy-grid-for-nav"> |
| |
| <nav data-toggle="wy-nav-shift" class="wy-nav-side"> |
| <div class="wy-side-scroll"> |
| <div class="wy-side-nav-search" > |
| |
| |
| |
| <a href="../../../../index.html" class="icon icon-home"> Airflow |
| |
| |
| |
| </a> |
| |
| |
| |
| |
| <div class="version"> |
| 1.10.5 |
| </div> |
| |
| |
| |
| |
| <div role="search"> |
| <form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get"> |
| <input type="text" name="q" placeholder="Search docs" /> |
| <input type="hidden" name="check_keywords" value="yes" /> |
| <input type="hidden" name="area" value="default" /> |
| </form> |
| </div> |
| |
| |
| </div> |
| |
| <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> |
| |
| |
| |
| |
| |
| |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../project.html">Project</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../license.html">License</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../start.html">Quick Start</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../installation.html">Installation</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../tutorial.html">Tutorial</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../howto/index.html">How-to Guides</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../ui.html">UI / Screenshots</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../concepts.html">Concepts</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../profiling.html">Data Profiling</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../cli.html">Command Line Interface Reference</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../scheduler.html">Scheduling & Triggers</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../plugins.html">Plugins</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../security.html">Security</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../timezone.html">Time zones</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../api.html">REST API Reference</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../integration.html">Integration</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../metrics.html">Metrics</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../kubernetes.html">Kubernetes</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../lineage.html">Lineage</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../changelog.html">Changelog</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../faq.html">FAQ</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../macros.html">Macros reference</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../_api/index.html">Python API Reference</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../privacy_notice.html">Privacy Notice</a></li> |
| </ul> |
| |
| |
| |
| </div> |
| </div> |
| </nav> |
| |
| <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> |
| |
| |
| <nav class="wy-nav-top" aria-label="top navigation"> |
| |
| <i data-toggle="wy-nav-top" class="fa fa-bars"></i> |
| <a href="../../../../index.html">Airflow</a> |
| |
| </nav> |
| |
| |
| <div class="wy-nav-content"> |
| |
| <div class="rst-content"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div role="navigation" aria-label="breadcrumbs navigation"> |
| |
| <ul class="wy-breadcrumbs"> |
| |
| <li><a href="../../../../index.html">Docs</a> »</li> |
| |
| <li><a href="../../../index.html">Module code</a> »</li> |
| |
| <li><a href="../hooks.html">airflow.contrib.hooks</a> »</li> |
| |
| <li>airflow.contrib.hooks.gcp_bigtable_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_bigtable_hook</h1><div class="highlight"><pre> |
| <span></span><span class="c1"># -*- coding: utf-8 -*-</span> |
| <span class="c1">#</span> |
| <span class="c1"># Licensed to the Apache Software Foundation (ASF) under one</span> |
| <span class="c1"># or more contributor license agreements. See the NOTICE file</span> |
| <span class="c1"># distributed with this work for additional information</span> |
| <span class="c1"># regarding copyright ownership. The ASF licenses this file</span> |
| <span class="c1"># to you under the Apache License, Version 2.0 (the</span> |
| <span class="c1"># "License"); you may not use this file except in compliance</span> |
| <span class="c1"># with the License. You may obtain a copy of the License at</span> |
| <span class="c1">#</span> |
| <span class="c1"># http://www.apache.org/licenses/LICENSE-2.0</span> |
| <span class="c1">#</span> |
| <span class="c1"># Unless required by applicable law or agreed to in writing,</span> |
| <span class="c1"># software distributed under the License is distributed on an</span> |
| <span class="c1"># "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span> |
| <span class="c1"># KIND, either express or implied. See the License for the</span> |
| <span class="c1"># specific language governing permissions and limitations</span> |
| <span class="c1"># under the License.</span> |
| |
| <span class="kn">from</span> <span class="nn">google.cloud.bigtable</span> <span class="k">import</span> <span class="n">Client</span> |
| <span class="kn">from</span> <span class="nn">google.cloud.bigtable.cluster</span> <span class="k">import</span> <span class="n">Cluster</span> |
| <span class="kn">from</span> <span class="nn">google.cloud.bigtable.instance</span> <span class="k">import</span> <span class="n">Instance</span> |
| <span class="kn">from</span> <span class="nn">google.cloud.bigtable.table</span> <span class="k">import</span> <span class="n">Table</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">airflow.contrib.hooks.gcp_api_base_hook</span> <span class="k">import</span> <span class="n">GoogleCloudBaseHook</span> |
| |
| |
| <div class="viewcode-block" id="BigtableHook"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_bigtable_hook/index.html#airflow.contrib.hooks.gcp_bigtable_hook.BigtableHook">[docs]</a><span class="k">class</span> <span class="nc">BigtableHook</span><span class="p">(</span><span class="n">GoogleCloudBaseHook</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Hook for Google Cloud Bigtable APIs.</span> |
| |
| <span class="sd"> All the methods in the hook where project_id is used must be called with</span> |
| <span class="sd"> keyword arguments rather than positional.</span> |
| <span class="sd"> """</span> |
| |
| <div class="viewcode-block" id="BigtableHook._client"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_bigtable_hook/index.html#airflow.contrib.hooks.gcp_bigtable_hook.BigtableHook._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">'google_cloud_default'</span><span class="p">,</span> |
| <span class="n">delegate_to</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="nb">super</span><span class="p">(</span><span class="n">BigtableHook</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="BigtableHook._get_client"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_bigtable_hook/index.html#airflow.contrib.hooks.gcp_bigtable_hook.BigtableHook._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="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="n">admin</span><span class="o">=</span><span class="kc">True</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="BigtableHook.get_instance"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_bigtable_hook/index.html#airflow.contrib.hooks.gcp_bigtable_hook.BigtableHook.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">"""</span> |
| <span class="sd"> Retrieves and returns the specified Cloud Bigtable instance if it exists.</span> |
| <span class="sd"> Otherwise, returns None.</span> |
| |
| <span class="sd"> :param instance_id: The ID of the Cloud Bigtable instance.</span> |
| <span class="sd"> :type instance_id: str</span> |
| <span class="sd"> :param project_id: Optional, Google Cloud Platform project ID where the</span> |
| <span class="sd"> BigTable exists. 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"> """</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">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> |
| |
| <span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">fallback_to_default_project_id</span> |
| <div class="viewcode-block" id="BigtableHook.delete_instance"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_bigtable_hook/index.html#airflow.contrib.hooks.gcp_bigtable_hook.BigtableHook.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">"""</span> |
| <span class="sd"> Deletes the specified Cloud Bigtable instance.</span> |
| <span class="sd"> Raises google.api_core.exceptions.NotFound if the Cloud Bigtable instance does</span> |
| <span class="sd"> not exist.</span> |
| |
| <span class="sd"> :param project_id: Optional, Google Cloud Platform project ID where the</span> |
| <span class="sd"> BigTable exists. 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"> :param instance_id: The ID of the Cloud Bigtable instance.</span> |
| <span class="sd"> :type instance_id: str</span> |
| <span class="sd"> """</span> |
| <span class="n">instance</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_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">project_id</span><span class="o">=</span><span class="n">project_id</span><span class="p">)</span> |
| <span class="k">if</span> <span class="n">instance</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">else</span><span class="p">:</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">"The instance '</span><span class="si">%s</span><span class="s2">' does not exist in project '</span><span class="si">%s</span><span class="s2">'. Exiting"</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></div> |
| |
| <span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">fallback_to_default_project_id</span> |
| <div class="viewcode-block" id="BigtableHook.create_instance"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_bigtable_hook/index.html#airflow.contrib.hooks.gcp_bigtable_hook.BigtableHook.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">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="n">enums</span><span class="o">.</span><span class="n">Instance</span><span class="o">.</span><span class="n">Type</span><span class="o">.</span><span class="n">TYPE_UNSPECIFIED</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="n">enums</span><span class="o">.</span><span class="n">StorageType</span><span class="o">.</span><span class="n">STORAGE_TYPE_UNSPECIFIED</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="sd">"""</span> |
| <span class="sd"> Creates new instance.</span> |
| |
| <span class="sd"> :type instance_id: str</span> |
| <span class="sd"> :param instance_id: The ID for the new instance.</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, Google Cloud Platform project ID where the</span> |
| <span class="sd"> BigTable exists. 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</span> |
| <span class="sd"> 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.Instance.Type</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.</span> |
| <span class="sd"> Defaults to ``instance_id``.</span> |
| <span class="sd"> :type instance_labels: dict</span> |
| <span class="sd"> :param instance_labels: (optional) Dictionary of labels to associate with the</span> |
| <span class="sd"> 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.StorageType</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"> """</span> |
| <span class="n">cluster_storage_type</span> <span class="o">=</span> <span class="n">enums</span><span class="o">.</span><span class="n">StorageType</span><span class="p">(</span><span class="n">cluster_storage_type</span><span class="p">)</span> |
| <span class="n">instance_type</span> <span class="o">=</span> <span class="n">enums</span><span class="o">.</span><span class="n">Instance</span><span class="o">.</span><span class="n">Type</span><span class="p">(</span><span class="n">instance_type</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">instance_id</span><span class="p">,</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="n">instance_display_name</span><span class="p">,</span> |
| <span class="n">instance_type</span><span class="p">,</span> |
| <span class="n">instance_labels</span><span class="p">,</span> |
| <span class="p">)</span> |
| |
| <span class="n">clusters</span> <span class="o">=</span> <span class="p">[</span> |
| <span class="n">instance</span><span class="o">.</span><span class="n">cluster</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">cluster_nodes</span><span class="p">,</span> |
| <span class="n">cluster_storage_type</span> |
| <span class="p">)</span> |
| <span class="p">]</span> |
| <span class="k">if</span> <span class="n">replica_cluster_id</span> <span class="ow">and</span> <span class="n">replica_cluster_zone</span><span class="p">:</span> |
| <span class="n">clusters</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">instance</span><span class="o">.</span><span class="n">cluster</span><span class="p">(</span> |
| <span class="n">replica_cluster_id</span><span class="p">,</span> |
| <span class="n">replica_cluster_zone</span><span class="p">,</span> |
| <span class="n">cluster_nodes</span><span class="p">,</span> |
| <span class="n">cluster_storage_type</span> |
| <span class="p">))</span> |
| <span class="n">operation</span> <span class="o">=</span> <span class="n">instance</span><span class="o">.</span><span class="n">create</span><span class="p">(</span> |
| <span class="n">clusters</span><span class="o">=</span><span class="n">clusters</span> |
| <span class="p">)</span> |
| <span class="n">operation</span><span class="o">.</span><span class="n">result</span><span class="p">(</span><span class="n">timeout</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">instance</span></div> |
| |
| <span class="nd">@staticmethod</span> |
| <div class="viewcode-block" id="BigtableHook.create_table"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_bigtable_hook/index.html#airflow.contrib.hooks.gcp_bigtable_hook.BigtableHook.create_table">[docs]</a> <span class="k">def</span> <span class="nf">create_table</span><span class="p">(</span><span class="n">instance</span><span class="p">,</span> |
| <span class="n">table_id</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="sd">"""</span> |
| <span class="sd"> Creates the specified Cloud Bigtable table.</span> |
| <span class="sd"> Raises ``google.api_core.exceptions.AlreadyExists`` if the table exists.</span> |
| |
| <span class="sd"> :type instance: Instance</span> |
| <span class="sd"> :param instance: The Cloud Bigtable instance that owns the table.</span> |
| <span class="sd"> :type table_id: str</span> |
| <span class="sd"> :param table_id: The ID of the table to create in Cloud Bigtable.</span> |
| <span class="sd"> :type initial_split_keys: list</span> |
| <span class="sd"> :param initial_split_keys: (Optional) A list of row keys in bytes to use to</span> |
| <span class="sd"> initially split the table.</span> |
| <span class="sd"> :type column_families: dict</span> |
| <span class="sd"> :param column_families: (Optional) A map of columns to create. The key is the</span> |
| <span class="sd"> column_id str, and the value is a</span> |
| <span class="sd"> :class:`google.cloud.bigtable.column_family.GarbageCollectionRule`.</span> |
| <span class="sd"> """</span> |
| <span class="k">if</span> <span class="n">column_families</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="n">column_families</span> <span class="o">=</span> <span class="p">{}</span> |
| <span class="k">if</span> <span class="n">initial_split_keys</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="n">initial_split_keys</span> <span class="o">=</span> <span class="p">[]</span> |
| <span class="n">table</span> <span class="o">=</span> <span class="n">Table</span><span class="p">(</span><span class="n">table_id</span><span class="p">,</span> <span class="n">instance</span><span class="p">)</span> |
| <span class="n">table</span><span class="o">.</span><span class="n">create</span><span class="p">(</span><span class="n">initial_split_keys</span><span class="p">,</span> <span class="n">column_families</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="BigtableHook.delete_table"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_bigtable_hook/index.html#airflow.contrib.hooks.gcp_bigtable_hook.BigtableHook.delete_table">[docs]</a> <span class="k">def</span> <span class="nf">delete_table</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="sd">"""</span> |
| <span class="sd"> Deletes the specified table in Cloud Bigtable.</span> |
| <span class="sd"> Raises google.api_core.exceptions.NotFound if the table does not exist.</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 in Cloud Bigtable.</span> |
| <span class="sd"> :type project_id: str</span> |
| <span class="sd"> :param project_id: Optional, Google Cloud Platform project ID where the</span> |
| <span class="sd"> BigTable exists. If set to None or missing,</span> |
| <span class="sd"> the default project_id from the GCP connection is used.</span> |
| <span class="sd"> """</span> |
| <span class="n">table</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_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">project_id</span><span class="o">=</span><span class="n">project_id</span><span class="p">)</span><span class="o">.</span><span class="n">table</span><span class="p">(</span><span class="n">table_id</span><span class="o">=</span><span class="n">table_id</span><span class="p">)</span> |
| <span class="n">table</span><span class="o">.</span><span class="n">delete</span><span class="p">()</span></div> |
| |
| <span class="nd">@staticmethod</span> |
| <div class="viewcode-block" id="BigtableHook.update_cluster"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_bigtable_hook/index.html#airflow.contrib.hooks.gcp_bigtable_hook.BigtableHook.update_cluster">[docs]</a> <span class="k">def</span> <span class="nf">update_cluster</span><span class="p">(</span><span class="n">instance</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="sd">"""</span> |
| <span class="sd"> Updates number of nodes in the specified Cloud Bigtable cluster.</span> |
| <span class="sd"> Raises google.api_core.exceptions.NotFound if the cluster does not exist.</span> |
| |
| <span class="sd"> :type instance: Instance</span> |
| <span class="sd"> :param instance: The Cloud Bigtable instance that owns the cluster.</span> |
| <span class="sd"> :type cluster_id: str</span> |
| <span class="sd"> :param cluster_id: The ID of the cluster.</span> |
| <span class="sd"> :type nodes: int</span> |
| <span class="sd"> :param nodes: The desired number of nodes.</span> |
| <span class="sd"> """</span> |
| <span class="n">cluster</span> <span class="o">=</span> <span class="n">Cluster</span><span class="p">(</span><span class="n">cluster_id</span><span class="p">,</span> <span class="n">instance</span><span class="p">)</span> |
| <span class="n">cluster</span><span class="o">.</span><span class="n">serve_nodes</span> <span class="o">=</span> <span class="n">nodes</span> |
| <span class="n">cluster</span><span class="o">.</span><span class="n">update</span><span class="p">()</span></div> |
| |
| <span class="nd">@staticmethod</span> |
| <div class="viewcode-block" id="BigtableHook.get_column_families_for_table"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_bigtable_hook/index.html#airflow.contrib.hooks.gcp_bigtable_hook.BigtableHook.get_column_families_for_table">[docs]</a> <span class="k">def</span> <span class="nf">get_column_families_for_table</span><span class="p">(</span><span class="n">instance</span><span class="p">,</span> <span class="n">table_id</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Fetches Column Families for the specified table in Cloud Bigtable.</span> |
| |
| <span class="sd"> :type instance: Instance</span> |
| <span class="sd"> :param instance: The Cloud Bigtable instance that owns the table.</span> |
| <span class="sd"> :type table_id: str</span> |
| <span class="sd"> :param table_id: The ID of the table in Cloud Bigtable to fetch Column Families</span> |
| <span class="sd"> from.</span> |
| <span class="sd"> """</span> |
| |
| <span class="n">table</span> <span class="o">=</span> <span class="n">Table</span><span class="p">(</span><span class="n">table_id</span><span class="p">,</span> <span class="n">instance</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">table</span><span class="o">.</span><span class="n">list_column_families</span><span class="p">()</span></div> |
| |
| <span class="nd">@staticmethod</span> |
| <div class="viewcode-block" id="BigtableHook.get_cluster_states_for_table"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_bigtable_hook/index.html#airflow.contrib.hooks.gcp_bigtable_hook.BigtableHook.get_cluster_states_for_table">[docs]</a> <span class="k">def</span> <span class="nf">get_cluster_states_for_table</span><span class="p">(</span><span class="n">instance</span><span class="p">,</span> <span class="n">table_id</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Fetches Cluster States for the specified table in Cloud Bigtable.</span> |
| <span class="sd"> Raises google.api_core.exceptions.NotFound if the table does not exist.</span> |
| |
| <span class="sd"> :type instance: Instance</span> |
| <span class="sd"> :param instance: The Cloud Bigtable instance that owns the table.</span> |
| <span class="sd"> :type table_id: str</span> |
| <span class="sd"> :param table_id: The ID of the table in Cloud Bigtable to fetch Cluster States</span> |
| <span class="sd"> from.</span> |
| <span class="sd"> """</span> |
| |
| <span class="n">table</span> <span class="o">=</span> <span class="n">Table</span><span class="p">(</span><span class="n">table_id</span><span class="p">,</span> <span class="n">instance</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">table</span><span class="o">.</span><span class="n">get_cluster_states</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>. |
| <div class="footer">This page uses <a href="https://analytics.google.com/"> |
| Google Analytics</a> to collect statistics. You can disable it by blocking |
| the JavaScript coming from www.google-analytics.com. Check our |
| <a href="../../../../privacy_notice.html">Privacy Policy</a> |
| for more details. |
| <script type="text/javascript"> |
| (function() { |
| var ga = document.createElement('script'); |
| ga.src = ('https:' == document.location.protocol ? |
| 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; |
| ga.setAttribute('async', 'true'); |
| var nodes = document.documentElement.childNodes; |
| var i = -1; |
| var node; |
| do { |
| i++; |
| node = nodes[i] |
| } while(node.nodeType !== Node.ELEMENT_NODE); |
| node.appendChild(ga); |
| })(); |
| </script> |
| </div> |
| |
| |
| </footer> |
| |
| </div> |
| </div> |
| |
| </section> |
| |
| </div> |
| |
| |
| |
| <script type="text/javascript"> |
| jQuery(function () { |
| SphinxRtdTheme.Navigation.enable(true); |
| }); |
| </script> |
| |
| |
| |
| |
| |
| |
| </body> |
| </html> |
