| |
| |
| <!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.bigquery_hook — Airflow Documentation</title> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <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 src="../../../../_static/js/modernizr.min.js"></script> |
| |
| </head> |
| |
| <body class="wy-body-for-nav"> |
| |
| |
| <div class="wy-grid-for-nav"> |
| |
| |
| <nav data-toggle="wy-nav-shift" class="wy-nav-side"> |
| <div class="wy-side-scroll"> |
| <div class="wy-side-nav-search"> |
| |
| |
| |
| <a href="../../../../index.html" class="icon icon-home"> Airflow |
| |
| |
| |
| </a> |
| |
| |
| |
| |
| |
| |
| |
| <div 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 & 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="../../../../lineage.html">Lineage</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="../../../../code.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> »</li> |
| |
| <li><a href="../../../index.html">Module code</a> »</li> |
| |
| <li>airflow.contrib.hooks.bigquery_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.bigquery_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="c1">#</span> |
| <span class="sd">"""</span> |
| <span class="sd">This module contains a BigQuery Hook, as well as a very basic PEP 249</span> |
| <span class="sd">implementation for BigQuery.</span> |
| <span class="sd">"""</span> |
| |
| <span class="kn">import</span> <span class="nn">time</span> |
| <span class="kn">from</span> <span class="nn">builtins</span> <span class="k">import</span> <span class="nb">range</span> |
| |
| <span class="kn">from</span> <span class="nn">past.builtins</span> <span class="k">import</span> <span class="n">basestring</span> |
| |
| <span class="kn">from</span> <span class="nn">airflow</span> <span class="k">import</span> <span class="n">AirflowException</span> |
| <span class="kn">from</span> <span class="nn">airflow.contrib.hooks.gcp_api_base_hook</span> <span class="k">import</span> <span class="n">GoogleCloudBaseHook</span> |
| <span class="kn">from</span> <span class="nn">airflow.hooks.dbapi_hook</span> <span class="k">import</span> <span class="n">DbApiHook</span> |
| <span class="kn">from</span> <span class="nn">airflow.utils.log.logging_mixin</span> <span class="k">import</span> <span class="n">LoggingMixin</span> |
| <span class="kn">from</span> <span class="nn">apiclient.discovery</span> <span class="k">import</span> <span class="n">HttpError</span><span class="p">,</span> <span class="n">build</span> |
| <span class="kn">from</span> <span class="nn">googleapiclient</span> <span class="k">import</span> <span class="n">errors</span> |
| <span class="kn">from</span> <span class="nn">pandas_gbq.gbq</span> <span class="k">import</span> \ |
| <span class="n">_check_google_client_version</span> <span class="k">as</span> <span class="n">gbq_check_google_client_version</span> |
| <span class="kn">from</span> <span class="nn">pandas_gbq</span> <span class="k">import</span> <span class="n">read_gbq</span> |
| <span class="kn">from</span> <span class="nn">pandas_gbq.gbq</span> <span class="k">import</span> \ |
| <span class="n">_test_google_api_imports</span> <span class="k">as</span> <span class="n">gbq_test_google_api_imports</span> |
| <span class="kn">from</span> <span class="nn">pandas_gbq.gbq</span> <span class="k">import</span> <span class="n">GbqConnector</span> |
| |
| |
| <div class="viewcode-block" id="BigQueryHook"><a class="viewcode-back" href="../../../../integration.html#airflow.contrib.hooks.bigquery_hook.BigQueryHook">[docs]</a><span class="k">class</span> <span class="nc">BigQueryHook</span><span class="p">(</span><span class="n">GoogleCloudBaseHook</span><span class="p">,</span> <span class="n">DbApiHook</span><span class="p">,</span> <span class="n">LoggingMixin</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Interact with BigQuery. This hook uses the Google Cloud Platform</span> |
| <span class="sd"> connection.</span> |
| <span class="sd"> """</span> |
| <span class="n">conn_name_attr</span> <span class="o">=</span> <span class="s1">'bigquery_conn_id'</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">bigquery_conn_id</span><span class="o">=</span><span class="s1">'bigquery_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="n">use_legacy_sql</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span> |
| <span class="nb">super</span><span class="p">(</span><span class="n">BigQueryHook</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="o">=</span><span class="n">bigquery_conn_id</span><span class="p">,</span> <span class="n">delegate_to</span><span class="o">=</span><span class="n">delegate_to</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">use_legacy_sql</span> <span class="o">=</span> <span class="n">use_legacy_sql</span> |
| |
| <div class="viewcode-block" id="BigQueryHook.get_conn"><a class="viewcode-back" href="../../../../integration.html#airflow.contrib.hooks.bigquery_hook.BigQueryHook.get_conn">[docs]</a> <span class="k">def</span> <span class="nf">get_conn</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Returns a BigQuery PEP 249 connection object.</span> |
| <span class="sd"> """</span> |
| <span class="n">service</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_service</span><span class="p">()</span> |
| <span class="n">project</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_field</span><span class="p">(</span><span class="s1">'project'</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">BigQueryConnection</span><span class="p">(</span> |
| <span class="n">service</span><span class="o">=</span><span class="n">service</span><span class="p">,</span> |
| <span class="n">project_id</span><span class="o">=</span><span class="n">project</span><span class="p">,</span> |
| <span class="n">use_legacy_sql</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">use_legacy_sql</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="BigQueryHook.get_service"><a class="viewcode-back" href="../../../../integration.html#airflow.contrib.hooks.bigquery_hook.BigQueryHook.get_service">[docs]</a> <span class="k">def</span> <span class="nf">get_service</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Returns a BigQuery service object.</span> |
| <span class="sd"> """</span> |
| <span class="n">http_authorized</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_authorize</span><span class="p">()</span> |
| <span class="k">return</span> <span class="n">build</span><span class="p">(</span> |
| <span class="s1">'bigquery'</span><span class="p">,</span> <span class="s1">'v2'</span><span class="p">,</span> <span class="n">http</span><span class="o">=</span><span class="n">http_authorized</span><span class="p">,</span> <span class="n">cache_discovery</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="BigQueryHook.insert_rows"><a class="viewcode-back" href="../../../../integration.html#airflow.contrib.hooks.bigquery_hook.BigQueryHook.insert_rows">[docs]</a> <span class="k">def</span> <span class="nf">insert_rows</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">table</span><span class="p">,</span> <span class="n">rows</span><span class="p">,</span> <span class="n">target_fields</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">commit_every</span><span class="o">=</span><span class="mi">1000</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Insertion is currently unsupported. Theoretically, you could use</span> |
| <span class="sd"> BigQuery's streaming API to insert rows into a table, but this hasn't</span> |
| <span class="sd"> been implemented.</span> |
| <span class="sd"> """</span> |
| <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div> |
| |
| <div class="viewcode-block" id="BigQueryHook.get_pandas_df"><a class="viewcode-back" href="../../../../integration.html#airflow.contrib.hooks.bigquery_hook.BigQueryHook.get_pandas_df">[docs]</a> <span class="k">def</span> <span class="nf">get_pandas_df</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">sql</span><span class="p">,</span> <span class="n">parameters</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">dialect</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Returns a Pandas DataFrame for the results produced by a BigQuery</span> |
| <span class="sd"> query. The DbApiHook method must be overridden because Pandas</span> |
| <span class="sd"> doesn't support PEP 249 connections, except for SQLite. See:</span> |
| |
| <span class="sd"> https://github.com/pydata/pandas/blob/master/pandas/io/sql.py#L447</span> |
| <span class="sd"> https://github.com/pydata/pandas/issues/6900</span> |
| |
| <span class="sd"> :param sql: The BigQuery SQL to execute.</span> |
| <span class="sd"> :type sql: string</span> |
| <span class="sd"> :param parameters: The parameters to render the SQL query with (not</span> |
| <span class="sd"> used, leave to override superclass method)</span> |
| <span class="sd"> :type parameters: mapping or iterable</span> |
| <span class="sd"> :param dialect: Dialect of BigQuery SQL – legacy SQL or standard SQL</span> |
| <span class="sd"> defaults to use `self.use_legacy_sql` if not specified</span> |
| <span class="sd"> :type dialect: string in {'legacy', 'standard'}</span> |
| <span class="sd"> """</span> |
| <span class="k">if</span> <span class="n">dialect</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="n">dialect</span> <span class="o">=</span> <span class="s1">'legacy'</span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">use_legacy_sql</span> <span class="k">else</span> <span class="s1">'standard'</span> |
| |
| <span class="k">return</span> <span class="n">read_gbq</span><span class="p">(</span><span class="n">sql</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">_get_field</span><span class="p">(</span><span class="s1">'project'</span><span class="p">),</span> |
| <span class="n">dialect</span><span class="o">=</span><span class="n">dialect</span><span class="p">,</span> |
| <span class="n">verbose</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="BigQueryHook.table_exists"><a class="viewcode-back" href="../../../../integration.html#airflow.contrib.hooks.bigquery_hook.BigQueryHook.table_exists">[docs]</a> <span class="k">def</span> <span class="nf">table_exists</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">project_id</span><span class="p">,</span> <span class="n">dataset_id</span><span class="p">,</span> <span class="n">table_id</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Checks for the existence of a table in Google BigQuery.</span> |
| |
| <span class="sd"> :param project_id: The Google cloud project in which to look for the</span> |
| <span class="sd"> table. The connection supplied to the hook must provide access to</span> |
| <span class="sd"> the specified project.</span> |
| <span class="sd"> :type project_id: string</span> |
| <span class="sd"> :param dataset_id: The name of the dataset in which to look for the</span> |
| <span class="sd"> table.</span> |
| <span class="sd"> :type dataset_id: string</span> |
| <span class="sd"> :param table_id: The name of the table to check the existence of.</span> |
| <span class="sd"> :type table_id: string</span> |
| <span class="sd"> """</span> |
| <span class="n">service</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_service</span><span class="p">()</span> |
| <span class="k">try</span><span class="p">:</span> |
| <span class="n">service</span><span class="o">.</span><span class="n">tables</span><span class="p">()</span><span class="o">.</span><span class="n">get</span><span class="p">(</span> |
| <span class="n">projectId</span><span class="o">=</span><span class="n">project_id</span><span class="p">,</span> <span class="n">datasetId</span><span class="o">=</span><span class="n">dataset_id</span><span class="p">,</span> |
| <span class="n">tableId</span><span class="o">=</span><span class="n">table_id</span><span class="p">)</span><span class="o">.</span><span class="n">execute</span><span class="p">()</span> |
| <span class="k">return</span> <span class="kc">True</span> |
| <span class="k">except</span> <span class="n">errors</span><span class="o">.</span><span class="n">HttpError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span> |
| <span class="k">if</span> <span class="n">e</span><span class="o">.</span><span class="n">resp</span><span class="p">[</span><span class="s1">'status'</span><span class="p">]</span> <span class="o">==</span> <span class="s1">'404'</span><span class="p">:</span> |
| <span class="k">return</span> <span class="kc">False</span> |
| <span class="k">raise</span></div></div> |
| |
| |
| <span class="k">class</span> <span class="nc">BigQueryPandasConnector</span><span class="p">(</span><span class="n">GbqConnector</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> This connector behaves identically to GbqConnector (from Pandas), except</span> |
| <span class="sd"> that it allows the service to be injected, and disables a call to</span> |
| <span class="sd"> self.get_credentials(). This allows Airflow to use BigQuery with Pandas</span> |
| <span class="sd"> without forcing a three legged OAuth connection. Instead, we can inject</span> |
| <span class="sd"> service account credentials into the binding.</span> |
| <span class="sd"> """</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">project_id</span><span class="p">,</span> |
| <span class="n">service</span><span class="p">,</span> |
| <span class="n">reauth</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> |
| <span class="n">verbose</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> |
| <span class="n">dialect</span><span class="o">=</span><span class="s1">'legacy'</span><span class="p">):</span> |
| <span class="nb">super</span><span class="p">(</span><span class="n">BigQueryPandasConnector</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">project_id</span><span class="p">)</span> |
| <span class="n">gbq_check_google_client_version</span><span class="p">()</span> |
| <span class="n">gbq_test_google_api_imports</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">reauth</span> <span class="o">=</span> <span class="n">reauth</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">service</span> <span class="o">=</span> <span class="n">service</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">verbose</span> <span class="o">=</span> <span class="n">verbose</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">dialect</span> <span class="o">=</span> <span class="n">dialect</span> |
| |
| |
| <span class="k">class</span> <span class="nc">BigQueryConnection</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> BigQuery does not have a notion of a persistent connection. Thus, these</span> |
| <span class="sd"> objects are small stateless factories for cursors, which do all the real</span> |
| <span class="sd"> work.</span> |
| <span class="sd"> """</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="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">_args</span> <span class="o">=</span> <span class="n">args</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_kwargs</span> <span class="o">=</span> <span class="n">kwargs</span> |
| |
| <span class="k">def</span> <span class="nf">close</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="sd">""" BigQueryConnection does not have anything to close. """</span> |
| <span class="k">pass</span> |
| |
| <span class="k">def</span> <span class="nf">commit</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="sd">""" BigQueryConnection does not support transactions. """</span> |
| <span class="k">pass</span> |
| |
| <span class="k">def</span> <span class="nf">cursor</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="sd">""" Return a new :py:class:`Cursor` object using the connection. """</span> |
| <span class="k">return</span> <span class="n">BigQueryCursor</span><span class="p">(</span><span class="o">*</span><span class="bp">self</span><span class="o">.</span><span class="n">_args</span><span class="p">,</span> <span class="o">**</span><span class="bp">self</span><span class="o">.</span><span class="n">_kwargs</span><span class="p">)</span> |
| |
| <span class="k">def</span> <span class="nf">rollback</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span> |
| <span class="s2">"BigQueryConnection does not have transactions"</span><span class="p">)</span> |
| |
| |
| <span class="k">class</span> <span class="nc">BigQueryBaseCursor</span><span class="p">(</span><span class="n">LoggingMixin</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> The BigQuery base cursor contains helper methods to execute queries against</span> |
| <span class="sd"> BigQuery. The methods can be used directly by operators, in cases where a</span> |
| <span class="sd"> PEP 249 cursor isn't needed.</span> |
| <span class="sd"> """</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">service</span><span class="p">,</span> <span class="n">project_id</span><span class="p">,</span> <span class="n">use_legacy_sql</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">service</span> <span class="o">=</span> <span class="n">service</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">use_legacy_sql</span> <span class="o">=</span> <span class="n">use_legacy_sql</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">running_job_id</span> <span class="o">=</span> <span class="kc">None</span> |
| |
| <span class="k">def</span> <span class="nf">create_empty_table</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> |
| <span class="n">project_id</span><span class="p">,</span> |
| <span class="n">dataset_id</span><span class="p">,</span> |
| <span class="n">table_id</span><span class="p">,</span> |
| <span class="n">schema_fields</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">time_partitioning</span><span class="o">=</span><span class="p">{},</span> |
| <span class="n">labels</span><span class="o">=</span><span class="kc">None</span> |
| <span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Creates a new, empty table in the dataset.</span> |
| |
| <span class="sd"> :param project_id: The project to create the table into.</span> |
| <span class="sd"> :type project_id: str</span> |
| <span class="sd"> :param dataset_id: The dataset to create the table into.</span> |
| <span class="sd"> :type dataset_id: str</span> |
| <span class="sd"> :param table_id: The Name of the table to be created.</span> |
| <span class="sd"> :type table_id: str</span> |
| <span class="sd"> :param schema_fields: If set, the schema field list as defined here:</span> |
| <span class="sd"> https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.load.schema</span> |
| <span class="sd"> :param labels: a dictionary containing labels for the table, passed to BigQuery</span> |
| <span class="sd"> :type labels: dict</span> |
| |
| <span class="sd"> **Example**: ::</span> |
| |
| <span class="sd"> schema_fields=[{"name": "emp_name", "type": "STRING", "mode": "REQUIRED"},</span> |
| <span class="sd"> {"name": "salary", "type": "INTEGER", "mode": "NULLABLE"}]</span> |
| |
| <span class="sd"> :type schema_fields: list</span> |
| <span class="sd"> :param time_partitioning: configure optional time partitioning fields i.e.</span> |
| <span class="sd"> partition by field, type and expiration as per API specifications.</span> |
| |
| <span class="sd"> .. seealso::</span> |
| <span class="sd"> https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#timePartitioning</span> |
| <span class="sd"> :type time_partitioning: dict</span> |
| |
| <span class="sd"> :return:</span> |
| <span class="sd"> """</span> |
| <span class="n">project_id</span> <span class="o">=</span> <span class="n">project_id</span> <span class="k">if</span> <span class="n">project_id</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="k">else</span> <span class="bp">self</span><span class="o">.</span><span class="n">project_id</span> |
| |
| <span class="n">table_resource</span> <span class="o">=</span> <span class="p">{</span> |
| <span class="s1">'tableReference'</span><span class="p">:</span> <span class="p">{</span> |
| <span class="s1">'tableId'</span><span class="p">:</span> <span class="n">table_id</span> |
| <span class="p">}</span> |
| <span class="p">}</span> |
| |
| <span class="k">if</span> <span class="n">schema_fields</span><span class="p">:</span> |
| <span class="n">table_resource</span><span class="p">[</span><span class="s1">'schema'</span><span class="p">]</span> <span class="o">=</span> <span class="p">{</span><span class="s1">'fields'</span><span class="p">:</span> <span class="n">schema_fields</span><span class="p">}</span> |
| |
| <span class="k">if</span> <span class="n">time_partitioning</span><span class="p">:</span> |
| <span class="n">table_resource</span><span class="p">[</span><span class="s1">'timePartitioning'</span><span class="p">]</span> <span class="o">=</span> <span class="n">time_partitioning</span> |
| |
| <span class="k">if</span> <span class="n">labels</span><span class="p">:</span> |
| <span class="n">table_resource</span><span class="p">[</span><span class="s1">'labels'</span><span class="p">]</span> <span class="o">=</span> <span class="n">labels</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="s1">'Creating Table </span><span class="si">%s</span><span class="s1">:</span><span class="si">%s</span><span class="s1">.</span><span class="si">%s</span><span class="s1">'</span><span class="p">,</span> |
| <span class="n">project_id</span><span class="p">,</span> <span class="n">dataset_id</span><span class="p">,</span> <span class="n">table_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">service</span><span class="o">.</span><span class="n">tables</span><span class="p">()</span><span class="o">.</span><span class="n">insert</span><span class="p">(</span> |
| <span class="n">projectId</span><span class="o">=</span><span class="n">project_id</span><span class="p">,</span> |
| <span class="n">datasetId</span><span class="o">=</span><span class="n">dataset_id</span><span class="p">,</span> |
| <span class="n">body</span><span class="o">=</span><span class="n">table_resource</span><span class="p">)</span><span class="o">.</span><span class="n">execute</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="s1">'Table created successfully: </span><span class="si">%s</span><span class="s1">:</span><span class="si">%s</span><span class="s1">.</span><span class="si">%s</span><span class="s1">'</span><span class="p">,</span> |
| <span class="n">project_id</span><span class="p">,</span> <span class="n">dataset_id</span><span class="p">,</span> <span class="n">table_id</span><span class="p">)</span> |
| |
| <span class="k">except</span> <span class="n">HttpError</span> <span class="k">as</span> <span class="n">err</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span> |
| <span class="s1">'BigQuery job failed. Error was: </span><span class="si">{}</span><span class="s1">'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">err</span><span class="o">.</span><span class="n">content</span><span class="p">)</span> |
| <span class="p">)</span> |
| |
| <span class="k">def</span> <span class="nf">create_external_table</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> |
| <span class="n">external_project_dataset_table</span><span class="p">,</span> |
| <span class="n">schema_fields</span><span class="p">,</span> |
| <span class="n">source_uris</span><span class="p">,</span> |
| <span class="n">source_format</span><span class="o">=</span><span class="s1">'CSV'</span><span class="p">,</span> |
| <span class="n">autodetect</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> |
| <span class="n">compression</span><span class="o">=</span><span class="s1">'NONE'</span><span class="p">,</span> |
| <span class="n">ignore_unknown_values</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> |
| <span class="n">max_bad_records</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> |
| <span class="n">skip_leading_rows</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> |
| <span class="n">field_delimiter</span><span class="o">=</span><span class="s1">','</span><span class="p">,</span> |
| <span class="n">quote_character</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">allow_quoted_newlines</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> |
| <span class="n">allow_jagged_rows</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> |
| <span class="n">src_fmt_configs</span><span class="o">=</span><span class="p">{},</span> |
| <span class="n">labels</span><span class="o">=</span><span class="kc">None</span> |
| <span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Creates a new external table in the dataset with the data in Google</span> |
| <span class="sd"> Cloud Storage. See here:</span> |
| |
| <span class="sd"> https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#resource</span> |
| |
| <span class="sd"> for more details about these parameters.</span> |
| |
| <span class="sd"> :param external_project_dataset_table:</span> |
| <span class="sd"> The dotted (<project>.|<project>:)<dataset>.<table>($<partition>) BigQuery</span> |
| <span class="sd"> table name to create external table.</span> |
| <span class="sd"> If <project> is not included, project will be the</span> |
| <span class="sd"> project defined in the connection json.</span> |
| <span class="sd"> :type external_project_dataset_table: string</span> |
| <span class="sd"> :param schema_fields: The schema field list as defined here:</span> |
| <span class="sd"> https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#resource</span> |
| <span class="sd"> :type schema_fields: list</span> |
| <span class="sd"> :param source_uris: The source Google Cloud</span> |
| <span class="sd"> Storage URI (e.g. gs://some-bucket/some-file.txt). A single wild</span> |
| <span class="sd"> per-object name can be used.</span> |
| <span class="sd"> :type source_uris: list</span> |
| <span class="sd"> :param source_format: File format to export.</span> |
| <span class="sd"> :type source_format: string</span> |
| <span class="sd"> :param autodetect: Try to detect schema and format options automatically.</span> |
| <span class="sd"> Any option specified explicitly will be honored.</span> |
| <span class="sd"> :type autodetect: bool</span> |
| <span class="sd"> :param compression: [Optional] The compression type of the data source.</span> |
| <span class="sd"> Possible values include GZIP and NONE.</span> |
| <span class="sd"> The default value is NONE.</span> |
| <span class="sd"> This setting is ignored for Google Cloud Bigtable,</span> |
| <span class="sd"> Google Cloud Datastore backups and Avro formats.</span> |
| <span class="sd"> :type compression: string</span> |
| <span class="sd"> :param ignore_unknown_values: [Optional] Indicates if BigQuery should allow</span> |
| <span class="sd"> extra values that are not represented in the table schema.</span> |
| <span class="sd"> If true, the extra values are ignored. If false, records with extra columns</span> |
| <span class="sd"> are treated as bad records, and if there are too many bad records, an</span> |
| <span class="sd"> invalid error is returned in the job result.</span> |
| <span class="sd"> :type ignore_unknown_values: bool</span> |
| <span class="sd"> :param max_bad_records: The maximum number of bad records that BigQuery can</span> |
| <span class="sd"> ignore when running the job.</span> |
| <span class="sd"> :type max_bad_records: int</span> |
| <span class="sd"> :param skip_leading_rows: Number of rows to skip when loading from a CSV.</span> |
| <span class="sd"> :type skip_leading_rows: int</span> |
| <span class="sd"> :param field_delimiter: The delimiter to use when loading from a CSV.</span> |
| <span class="sd"> :type field_delimiter: string</span> |
| <span class="sd"> :param quote_character: The value that is used to quote data sections in a CSV</span> |
| <span class="sd"> file.</span> |
| <span class="sd"> :type quote_character: string</span> |
| <span class="sd"> :param allow_quoted_newlines: Whether to allow quoted newlines (true) or not</span> |
| <span class="sd"> (false).</span> |
| <span class="sd"> :type allow_quoted_newlines: boolean</span> |
| <span class="sd"> :param allow_jagged_rows: Accept rows that are missing trailing optional columns.</span> |
| <span class="sd"> The missing values are treated as nulls. If false, records with missing</span> |
| <span class="sd"> trailing columns are treated as bad records, and if there are too many bad</span> |
| <span class="sd"> records, an invalid error is returned in the job result. Only applicable when</span> |
| <span class="sd"> soure_format is CSV.</span> |
| <span class="sd"> :type allow_jagged_rows: bool</span> |
| <span class="sd"> :param src_fmt_configs: configure optional fields specific to the source format</span> |
| <span class="sd"> :type src_fmt_configs: dict</span> |
| <span class="sd"> :param labels: a dictionary containing labels for the table, passed to BigQuery</span> |
| <span class="sd"> :type labels: dict</span> |
| <span class="sd"> """</span> |
| |
| <span class="n">project_id</span><span class="p">,</span> <span class="n">dataset_id</span><span class="p">,</span> <span class="n">external_table_id</span> <span class="o">=</span> \ |
| <span class="n">_split_tablename</span><span class="p">(</span><span class="n">table_input</span><span class="o">=</span><span class="n">external_project_dataset_table</span><span class="p">,</span> |
| <span class="n">default_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">var_name</span><span class="o">=</span><span class="s1">'external_project_dataset_table'</span><span class="p">)</span> |
| |
| <span class="c1"># bigquery only allows certain source formats</span> |
| <span class="c1"># we check to make sure the passed source format is valid</span> |
| <span class="c1"># if it's not, we raise a ValueError</span> |
| <span class="c1"># Refer to this link for more details:</span> |
| <span class="c1"># https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#externalDataConfiguration.sourceFormat</span> |
| |
| <span class="n">source_format</span> <span class="o">=</span> <span class="n">source_format</span><span class="o">.</span><span class="n">upper</span><span class="p">()</span> |
| <span class="n">allowed_formats</span> <span class="o">=</span> <span class="p">[</span> |
| <span class="s2">"CSV"</span><span class="p">,</span> <span class="s2">"NEWLINE_DELIMITED_JSON"</span><span class="p">,</span> <span class="s2">"AVRO"</span><span class="p">,</span> <span class="s2">"GOOGLE_SHEETS"</span><span class="p">,</span> |
| <span class="s2">"DATASTORE_BACKUP"</span><span class="p">,</span> <span class="s2">"PARQUET"</span> |
| <span class="p">]</span> |
| <span class="k">if</span> <span class="n">source_format</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">allowed_formats</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"</span><span class="si">{0}</span><span class="s2"> is not a valid source format. "</span> |
| <span class="s2">"Please use one of the following types: </span><span class="si">{1}</span><span class="s2">"</span> |
| <span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">source_format</span><span class="p">,</span> <span class="n">allowed_formats</span><span class="p">))</span> |
| |
| <span class="n">compression</span> <span class="o">=</span> <span class="n">compression</span><span class="o">.</span><span class="n">upper</span><span class="p">()</span> |
| <span class="n">allowed_compressions</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'NONE'</span><span class="p">,</span> <span class="s1">'GZIP'</span><span class="p">]</span> |
| <span class="k">if</span> <span class="n">compression</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">allowed_compressions</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"</span><span class="si">{0}</span><span class="s2"> is not a valid compression format. "</span> |
| <span class="s2">"Please use one of the following types: </span><span class="si">{1}</span><span class="s2">"</span> |
| <span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">compression</span><span class="p">,</span> <span class="n">allowed_compressions</span><span class="p">))</span> |
| |
| <span class="n">table_resource</span> <span class="o">=</span> <span class="p">{</span> |
| <span class="s1">'externalDataConfiguration'</span><span class="p">:</span> <span class="p">{</span> |
| <span class="s1">'autodetect'</span><span class="p">:</span> <span class="n">autodetect</span><span class="p">,</span> |
| <span class="s1">'sourceFormat'</span><span class="p">:</span> <span class="n">source_format</span><span class="p">,</span> |
| <span class="s1">'sourceUris'</span><span class="p">:</span> <span class="n">source_uris</span><span class="p">,</span> |
| <span class="s1">'compression'</span><span class="p">:</span> <span class="n">compression</span><span class="p">,</span> |
| <span class="s1">'ignoreUnknownValues'</span><span class="p">:</span> <span class="n">ignore_unknown_values</span> |
| <span class="p">},</span> |
| <span class="s1">'tableReference'</span><span class="p">:</span> <span class="p">{</span> |
| <span class="s1">'projectId'</span><span class="p">:</span> <span class="n">project_id</span><span class="p">,</span> |
| <span class="s1">'datasetId'</span><span class="p">:</span> <span class="n">dataset_id</span><span class="p">,</span> |
| <span class="s1">'tableId'</span><span class="p">:</span> <span class="n">external_table_id</span><span class="p">,</span> |
| <span class="p">}</span> |
| <span class="p">}</span> |
| |
| <span class="k">if</span> <span class="n">schema_fields</span><span class="p">:</span> |
| <span class="n">table_resource</span><span class="p">[</span><span class="s1">'externalDataConfiguration'</span><span class="p">]</span><span class="o">.</span><span class="n">update</span><span class="p">({</span> |
| <span class="s1">'schema'</span><span class="p">:</span> <span class="p">{</span> |
| <span class="s1">'fields'</span><span class="p">:</span> <span class="n">schema_fields</span> |
| <span class="p">}</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="s1">'Creating external table: </span><span class="si">%s</span><span class="s1">'</span><span class="p">,</span> <span class="n">external_project_dataset_table</span><span class="p">)</span> |
| |
| <span class="k">if</span> <span class="n">max_bad_records</span><span class="p">:</span> |
| <span class="n">table_resource</span><span class="p">[</span><span class="s1">'externalDataConfiguration'</span><span class="p">][</span><span class="s1">'maxBadRecords'</span><span class="p">]</span> <span class="o">=</span> <span class="n">max_bad_records</span> |
| |
| <span class="c1"># if following fields are not specified in src_fmt_configs,</span> |
| <span class="c1"># honor the top-level params for backward-compatibility</span> |
| <span class="k">if</span> <span class="s1">'skipLeadingRows'</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">src_fmt_configs</span><span class="p">:</span> |
| <span class="n">src_fmt_configs</span><span class="p">[</span><span class="s1">'skipLeadingRows'</span><span class="p">]</span> <span class="o">=</span> <span class="n">skip_leading_rows</span> |
| <span class="k">if</span> <span class="s1">'fieldDelimiter'</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">src_fmt_configs</span><span class="p">:</span> |
| <span class="n">src_fmt_configs</span><span class="p">[</span><span class="s1">'fieldDelimiter'</span><span class="p">]</span> <span class="o">=</span> <span class="n">field_delimiter</span> |
| <span class="k">if</span> <span class="s1">'quote_character'</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">src_fmt_configs</span><span class="p">:</span> |
| <span class="n">src_fmt_configs</span><span class="p">[</span><span class="s1">'quote'</span><span class="p">]</span> <span class="o">=</span> <span class="n">quote_character</span> |
| <span class="k">if</span> <span class="s1">'allowQuotedNewlines'</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">src_fmt_configs</span><span class="p">:</span> |
| <span class="n">src_fmt_configs</span><span class="p">[</span><span class="s1">'allowQuotedNewlines'</span><span class="p">]</span> <span class="o">=</span> <span class="n">allow_quoted_newlines</span> |
| <span class="k">if</span> <span class="s1">'allowJaggedRows'</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">src_fmt_configs</span><span class="p">:</span> |
| <span class="n">src_fmt_configs</span><span class="p">[</span><span class="s1">'allowJaggedRows'</span><span class="p">]</span> <span class="o">=</span> <span class="n">allow_jagged_rows</span> |
| |
| <span class="n">src_fmt_to_param_mapping</span> <span class="o">=</span> <span class="p">{</span> |
| <span class="s1">'CSV'</span><span class="p">:</span> <span class="s1">'csvOptions'</span><span class="p">,</span> |
| <span class="s1">'GOOGLE_SHEETS'</span><span class="p">:</span> <span class="s1">'googleSheetsOptions'</span> |
| <span class="p">}</span> |
| |
| <span class="n">src_fmt_to_configs_mapping</span> <span class="o">=</span> <span class="p">{</span> |
| <span class="s1">'csvOptions'</span><span class="p">:</span> <span class="p">[</span> |
| <span class="s1">'allowJaggedRows'</span><span class="p">,</span> <span class="s1">'allowQuotedNewlines'</span><span class="p">,</span> |
| <span class="s1">'fieldDelimiter'</span><span class="p">,</span> <span class="s1">'skipLeadingRows'</span><span class="p">,</span> |
| <span class="s1">'quote'</span> |
| <span class="p">],</span> |
| <span class="s1">'googleSheetsOptions'</span><span class="p">:</span> <span class="p">[</span><span class="s1">'skipLeadingRows'</span><span class="p">]</span> |
| <span class="p">}</span> |
| |
| <span class="k">if</span> <span class="n">source_format</span> <span class="ow">in</span> <span class="n">src_fmt_to_param_mapping</span><span class="o">.</span><span class="n">keys</span><span class="p">():</span> |
| |
| <span class="n">valid_configs</span> <span class="o">=</span> <span class="n">src_fmt_to_configs_mapping</span><span class="p">[</span> |
| <span class="n">src_fmt_to_param_mapping</span><span class="p">[</span><span class="n">source_format</span><span class="p">]</span> |
| <span class="p">]</span> |
| |
| <span class="n">src_fmt_configs</span> <span class="o">=</span> <span class="p">{</span> |
| <span class="n">k</span><span class="p">:</span> <span class="n">v</span> |
| <span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">src_fmt_configs</span><span class="o">.</span><span class="n">items</span><span class="p">()</span> <span class="k">if</span> <span class="n">k</span> <span class="ow">in</span> <span class="n">valid_configs</span> |
| <span class="p">}</span> |
| |
| <span class="n">table_resource</span><span class="p">[</span><span class="s1">'externalDataConfiguration'</span><span class="p">][</span><span class="n">src_fmt_to_param_mapping</span><span class="p">[</span> |
| <span class="n">source_format</span><span class="p">]]</span> <span class="o">=</span> <span class="n">src_fmt_configs</span> |
| |
| <span class="k">if</span> <span class="n">labels</span><span class="p">:</span> |
| <span class="n">table_resource</span><span class="p">[</span><span class="s1">'labels'</span><span class="p">]</span> <span class="o">=</span> <span class="n">labels</span> |
| |
| <span class="k">try</span><span class="p">:</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">service</span><span class="o">.</span><span class="n">tables</span><span class="p">()</span><span class="o">.</span><span class="n">insert</span><span class="p">(</span> |
| <span class="n">projectId</span><span class="o">=</span><span class="n">project_id</span><span class="p">,</span> |
| <span class="n">datasetId</span><span class="o">=</span><span class="n">dataset_id</span><span class="p">,</span> |
| <span class="n">body</span><span class="o">=</span><span class="n">table_resource</span> |
| <span class="p">)</span><span class="o">.</span><span class="n">execute</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="s1">'External table created successfully: </span><span class="si">%s</span><span class="s1">'</span><span class="p">,</span> |
| <span class="n">external_project_dataset_table</span><span class="p">)</span> |
| |
| <span class="k">except</span> <span class="n">HttpError</span> <span class="k">as</span> <span class="n">err</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span> |
| <span class="s1">'BigQuery job failed. Error was: </span><span class="si">{}</span><span class="s1">'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">err</span><span class="o">.</span><span class="n">content</span><span class="p">)</span> |
| <span class="p">)</span> |
| |
| <span class="k">def</span> <span class="nf">run_query</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> |
| <span class="n">bql</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">sql</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">destination_dataset_table</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> |
| <span class="n">write_disposition</span><span class="o">=</span><span class="s1">'WRITE_EMPTY'</span><span class="p">,</span> |
| <span class="n">allow_large_results</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> |
| <span class="n">flatten_results</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">udf_config</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> |
| <span class="n">use_legacy_sql</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">maximum_billing_tier</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">maximum_bytes_billed</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">create_disposition</span><span class="o">=</span><span class="s1">'CREATE_IF_NEEDED'</span><span class="p">,</span> |
| <span class="n">query_params</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">labels</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">schema_update_options</span><span class="o">=</span><span class="p">(),</span> |
| <span class="n">priority</span><span class="o">=</span><span class="s1">'INTERACTIVE'</span><span class="p">,</span> |
| <span class="n">time_partitioning</span><span class="o">=</span><span class="p">{}):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Executes a BigQuery SQL query. Optionally persists results in a BigQuery</span> |
| <span class="sd"> table. See here:</span> |
| |
| <span class="sd"> https://cloud.google.com/bigquery/docs/reference/v2/jobs</span> |
| |
| <span class="sd"> For more details about these parameters.</span> |
| |
| <span class="sd"> :param bql: (Deprecated. Use `sql` parameter instead) The BigQuery SQL</span> |
| <span class="sd"> to execute.</span> |
| <span class="sd"> :type bql: string</span> |
| <span class="sd"> :param sql: The BigQuery SQL to execute.</span> |
| <span class="sd"> :type sql: string</span> |
| <span class="sd"> :param destination_dataset_table: The dotted <dataset>.<table></span> |
| <span class="sd"> BigQuery table to save the query results.</span> |
| <span class="sd"> :type destination_dataset_table: string</span> |
| <span class="sd"> :param write_disposition: What to do if the table already exists in</span> |
| <span class="sd"> BigQuery.</span> |
| <span class="sd"> :type write_disposition: string</span> |
| <span class="sd"> :param allow_large_results: Whether to allow large results.</span> |
| <span class="sd"> :type allow_large_results: boolean</span> |
| <span class="sd"> :param flatten_results: If true and query uses legacy SQL dialect, flattens</span> |
| <span class="sd"> all nested and repeated fields in the query results. ``allowLargeResults``</span> |
| <span class="sd"> must be true if this is set to false. For standard SQL queries, this</span> |
| <span class="sd"> flag is ignored and results are never flattened.</span> |
| <span class="sd"> :type flatten_results: boolean</span> |
| <span class="sd"> :param udf_config: The User Defined Function configuration for the query.</span> |
| <span class="sd"> See https://cloud.google.com/bigquery/user-defined-functions for details.</span> |
| <span class="sd"> :param use_legacy_sql: Whether to use legacy SQL (true) or standard SQL (false).</span> |
| <span class="sd"> If `None`, defaults to `self.use_legacy_sql`.</span> |
| <span class="sd"> :type use_legacy_sql: boolean</span> |
| <span class="sd"> :type udf_config: list</span> |
| <span class="sd"> :param maximum_billing_tier: Positive integer that serves as a</span> |
| <span class="sd"> multiplier of the basic price.</span> |
| <span class="sd"> :type maximum_billing_tier: integer</span> |
| <span class="sd"> :param maximum_bytes_billed: Limits the bytes billed for this job.</span> |
| <span class="sd"> Queries that will have bytes billed beyond this limit will fail</span> |
| <span class="sd"> (without incurring a charge). If unspecified, this will be</span> |
| <span class="sd"> set to your project default.</span> |
| <span class="sd"> :type maximum_bytes_billed: float</span> |
| <span class="sd"> :param create_disposition: Specifies whether the job is allowed to</span> |
| <span class="sd"> create new tables.</span> |
| <span class="sd"> :type create_disposition: string</span> |
| <span class="sd"> :param query_params a dictionary containing query parameter types and</span> |
| <span class="sd"> values, passed to BigQuery</span> |
| <span class="sd"> :type query_params: dict</span> |
| <span class="sd"> :param labels a dictionary containing labels for the job/query,</span> |
| <span class="sd"> passed to BigQuery</span> |
| <span class="sd"> :type labels: dict</span> |
| <span class="sd"> :param schema_update_options: Allows the schema of the desitination</span> |
| <span class="sd"> table to be updated as a side effect of the query job.</span> |
| <span class="sd"> :type schema_update_options: tuple</span> |
| <span class="sd"> :param priority: Specifies a priority for the query.</span> |
| <span class="sd"> Possible values include INTERACTIVE and BATCH.</span> |
| <span class="sd"> The default value is INTERACTIVE.</span> |
| <span class="sd"> :type priority: string</span> |
| <span class="sd"> :param time_partitioning: configure optional time partitioning fields i.e.</span> |
| <span class="sd"> partition by field, type and expiration as per API specifications.</span> |
| <span class="sd"> :type time_partitioning: dict</span> |
| |
| <span class="sd"> """</span> |
| |
| <span class="c1"># TODO remove `bql` in Airflow 2.0 - Jira: [AIRFLOW-2513]</span> |
| <span class="n">sql</span> <span class="o">=</span> <span class="n">bql</span> <span class="k">if</span> <span class="n">sql</span> <span class="ow">is</span> <span class="kc">None</span> <span class="k">else</span> <span class="n">sql</span> |
| |
| <span class="k">if</span> <span class="n">bql</span><span class="p">:</span> |
| <span class="kn">import</span> <span class="nn">warnings</span> |
| <span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span><span class="s1">'Deprecated parameter `bql` used in '</span> |
| <span class="s1">'`BigQueryBaseCursor.run_query` '</span> |
| <span class="s1">'Use `sql` parameter instead to pass the sql to be '</span> |
| <span class="s1">'executed. `bql` parameter is deprecated and '</span> |
| <span class="s1">'will be removed in a future version of '</span> |
| <span class="s1">'Airflow.'</span><span class="p">,</span> |
| <span class="n">category</span><span class="o">=</span><span class="ne">DeprecationWarning</span><span class="p">)</span> |
| |
| <span class="k">if</span> <span class="n">sql</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s1">'`BigQueryBaseCursor.run_query` missing 1 required '</span> |
| <span class="s1">'positional argument: `sql`'</span><span class="p">)</span> |
| |
| <span class="c1"># BigQuery also allows you to define how you want a table's schema to change</span> |
| <span class="c1"># as a side effect of a query job</span> |
| <span class="c1"># for more details:</span> |
| <span class="c1"># https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.query.schemaUpdateOptions</span> |
| <span class="n">allowed_schema_update_options</span> <span class="o">=</span> <span class="p">[</span> |
| <span class="s1">'ALLOW_FIELD_ADDITION'</span><span class="p">,</span> <span class="s2">"ALLOW_FIELD_RELAXATION"</span> |
| <span class="p">]</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="nb">set</span><span class="p">(</span><span class="n">allowed_schema_update_options</span><span class="p">)</span><span class="o">.</span><span class="n">issuperset</span><span class="p">(</span> |
| <span class="nb">set</span><span class="p">(</span><span class="n">schema_update_options</span><span class="p">)):</span> |
| <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span> |
| <span class="s2">"</span><span class="si">{0}</span><span class="s2"> contains invalid schema update options. "</span> |
| <span class="s2">"Please only use one or more of the following options: </span><span class="si">{1}</span><span class="s2">"</span> |
| <span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">schema_update_options</span><span class="p">,</span> <span class="n">allowed_schema_update_options</span><span class="p">))</span> |
| |
| <span class="k">if</span> <span class="n">use_legacy_sql</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="n">use_legacy_sql</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">use_legacy_sql</span> |
| |
| <span class="n">configuration</span> <span class="o">=</span> <span class="p">{</span> |
| <span class="s1">'query'</span><span class="p">:</span> <span class="p">{</span> |
| <span class="s1">'query'</span><span class="p">:</span> <span class="n">sql</span><span class="p">,</span> |
| <span class="s1">'useLegacySql'</span><span class="p">:</span> <span class="n">use_legacy_sql</span><span class="p">,</span> |
| <span class="s1">'maximumBillingTier'</span><span class="p">:</span> <span class="n">maximum_billing_tier</span><span class="p">,</span> |
| <span class="s1">'maximumBytesBilled'</span><span class="p">:</span> <span class="n">maximum_bytes_billed</span><span class="p">,</span> |
| <span class="s1">'priority'</span><span class="p">:</span> <span class="n">priority</span> |
| <span class="p">}</span> |
| <span class="p">}</span> |
| |
| <span class="k">if</span> <span class="n">destination_dataset_table</span><span class="p">:</span> |
| <span class="k">if</span> <span class="s1">'.'</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">destination_dataset_table</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span> |
| <span class="s1">'Expected destination_dataset_table name in the format of '</span> |
| <span class="s1">'<dataset>.<table>. Got: </span><span class="si">{}</span><span class="s1">'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span> |
| <span class="n">destination_dataset_table</span><span class="p">))</span> |
| <span class="n">destination_project</span><span class="p">,</span> <span class="n">destination_dataset</span><span class="p">,</span> <span class="n">destination_table</span> <span class="o">=</span> \ |
| <span class="n">_split_tablename</span><span class="p">(</span><span class="n">table_input</span><span class="o">=</span><span class="n">destination_dataset_table</span><span class="p">,</span> |
| <span class="n">default_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">configuration</span><span class="p">[</span><span class="s1">'query'</span><span class="p">]</span><span class="o">.</span><span class="n">update</span><span class="p">({</span> |
| <span class="s1">'allowLargeResults'</span><span class="p">:</span> <span class="n">allow_large_results</span><span class="p">,</span> |
| <span class="s1">'flattenResults'</span><span class="p">:</span> <span class="n">flatten_results</span><span class="p">,</span> |
| <span class="s1">'writeDisposition'</span><span class="p">:</span> <span class="n">write_disposition</span><span class="p">,</span> |
| <span class="s1">'createDisposition'</span><span class="p">:</span> <span class="n">create_disposition</span><span class="p">,</span> |
| <span class="s1">'destinationTable'</span><span class="p">:</span> <span class="p">{</span> |
| <span class="s1">'projectId'</span><span class="p">:</span> <span class="n">destination_project</span><span class="p">,</span> |
| <span class="s1">'datasetId'</span><span class="p">:</span> <span class="n">destination_dataset</span><span class="p">,</span> |
| <span class="s1">'tableId'</span><span class="p">:</span> <span class="n">destination_table</span><span class="p">,</span> |
| <span class="p">}</span> |
| <span class="p">})</span> |
| <span class="k">if</span> <span class="n">udf_config</span><span class="p">:</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">udf_config</span><span class="p">,</span> <span class="nb">list</span><span class="p">):</span> |
| <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s2">"udf_config argument must have a type 'list'"</span> |
| <span class="s2">" not </span><span class="si">{}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="nb">type</span><span class="p">(</span><span class="n">udf_config</span><span class="p">)))</span> |
| <span class="n">configuration</span><span class="p">[</span><span class="s1">'query'</span><span class="p">]</span><span class="o">.</span><span class="n">update</span><span class="p">({</span> |
| <span class="s1">'userDefinedFunctionResources'</span><span class="p">:</span> <span class="n">udf_config</span> |
| <span class="p">})</span> |
| |
| <span class="k">if</span> <span class="n">query_params</span><span class="p">:</span> |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">use_legacy_sql</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"Query paramaters are not allowed when using "</span> |
| <span class="s2">"legacy SQL"</span><span class="p">)</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="n">configuration</span><span class="p">[</span><span class="s1">'query'</span><span class="p">][</span><span class="s1">'queryParameters'</span><span class="p">]</span> <span class="o">=</span> <span class="n">query_params</span> |
| |
| <span class="k">if</span> <span class="n">labels</span><span class="p">:</span> |
| <span class="n">configuration</span><span class="p">[</span><span class="s1">'labels'</span><span class="p">]</span> <span class="o">=</span> <span class="n">labels</span> |
| |
| <span class="n">time_partitioning</span> <span class="o">=</span> <span class="n">_cleanse_time_partitioning</span><span class="p">(</span> |
| <span class="n">destination_dataset_table</span><span class="p">,</span> |
| <span class="n">time_partitioning</span> |
| <span class="p">)</span> |
| <span class="k">if</span> <span class="n">time_partitioning</span><span class="p">:</span> |
| <span class="n">configuration</span><span class="p">[</span><span class="s1">'query'</span><span class="p">]</span><span class="o">.</span><span class="n">update</span><span class="p">({</span> |
| <span class="s1">'timePartitioning'</span><span class="p">:</span> <span class="n">time_partitioning</span> |
| <span class="p">})</span> |
| |
| <span class="k">if</span> <span class="n">schema_update_options</span><span class="p">:</span> |
| <span class="k">if</span> <span class="n">write_disposition</span> <span class="ow">not</span> <span class="ow">in</span> <span class="p">[</span><span class="s2">"WRITE_APPEND"</span><span class="p">,</span> <span class="s2">"WRITE_TRUNCATE"</span><span class="p">]:</span> |
| <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"schema_update_options is only "</span> |
| <span class="s2">"allowed if write_disposition is "</span> |
| <span class="s2">"'WRITE_APPEND' or 'WRITE_TRUNCATE'."</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">"Adding experimental "</span> |
| <span class="s2">"'schemaUpdateOptions': </span><span class="si">{0}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">schema_update_options</span><span class="p">))</span> |
| <span class="n">configuration</span><span class="p">[</span><span class="s1">'query'</span><span class="p">][</span> |
| <span class="s1">'schemaUpdateOptions'</span><span class="p">]</span> <span class="o">=</span> <span class="n">schema_update_options</span> |
| |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">run_with_configuration</span><span class="p">(</span><span class="n">configuration</span><span class="p">)</span> |
| |
| <span class="k">def</span> <span class="nf">run_extract</span><span class="p">(</span> <span class="c1"># noqa</span> |
| <span class="bp">self</span><span class="p">,</span> |
| <span class="n">source_project_dataset_table</span><span class="p">,</span> |
| <span class="n">destination_cloud_storage_uris</span><span class="p">,</span> |
| <span class="n">compression</span><span class="o">=</span><span class="s1">'NONE'</span><span class="p">,</span> |
| <span class="n">export_format</span><span class="o">=</span><span class="s1">'CSV'</span><span class="p">,</span> |
| <span class="n">field_delimiter</span><span class="o">=</span><span class="s1">','</span><span class="p">,</span> |
| <span class="n">print_header</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> |
| <span class="n">labels</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Executes a BigQuery extract command to copy data from BigQuery to</span> |
| <span class="sd"> Google Cloud Storage. See here:</span> |
| |
| <span class="sd"> https://cloud.google.com/bigquery/docs/reference/v2/jobs</span> |
| |
| <span class="sd"> For more details about these parameters.</span> |
| |
| <span class="sd"> :param source_project_dataset_table: The dotted <dataset>.<table></span> |
| <span class="sd"> BigQuery table to use as the source data.</span> |
| <span class="sd"> :type source_project_dataset_table: string</span> |
| <span class="sd"> :param destination_cloud_storage_uris: The destination Google Cloud</span> |
| <span class="sd"> Storage URI (e.g. gs://some-bucket/some-file.txt). Follows</span> |
| <span class="sd"> convention defined here:</span> |
| <span class="sd"> https://cloud.google.com/bigquery/exporting-data-from-bigquery#exportingmultiple</span> |
| <span class="sd"> :type destination_cloud_storage_uris: list</span> |
| <span class="sd"> :param compression: Type of compression to use.</span> |
| <span class="sd"> :type compression: string</span> |
| <span class="sd"> :param export_format: File format to export.</span> |
| <span class="sd"> :type export_format: string</span> |
| <span class="sd"> :param field_delimiter: The delimiter to use when extracting to a CSV.</span> |
| <span class="sd"> :type field_delimiter: string</span> |
| <span class="sd"> :param print_header: Whether to print a header for a CSV file extract.</span> |
| <span class="sd"> :type print_header: boolean</span> |
| <span class="sd"> :param labels: a dictionary containing labels for the job/query,</span> |
| <span class="sd"> passed to BigQuery</span> |
| <span class="sd"> :type labels: dict</span> |
| <span class="sd"> """</span> |
| |
| <span class="n">source_project</span><span class="p">,</span> <span class="n">source_dataset</span><span class="p">,</span> <span class="n">source_table</span> <span class="o">=</span> \ |
| <span class="n">_split_tablename</span><span class="p">(</span><span class="n">table_input</span><span class="o">=</span><span class="n">source_project_dataset_table</span><span class="p">,</span> |
| <span class="n">default_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">var_name</span><span class="o">=</span><span class="s1">'source_project_dataset_table'</span><span class="p">)</span> |
| |
| <span class="n">configuration</span> <span class="o">=</span> <span class="p">{</span> |
| <span class="s1">'extract'</span><span class="p">:</span> <span class="p">{</span> |
| <span class="s1">'sourceTable'</span><span class="p">:</span> <span class="p">{</span> |
| <span class="s1">'projectId'</span><span class="p">:</span> <span class="n">source_project</span><span class="p">,</span> |
| <span class="s1">'datasetId'</span><span class="p">:</span> <span class="n">source_dataset</span><span class="p">,</span> |
| <span class="s1">'tableId'</span><span class="p">:</span> <span class="n">source_table</span><span class="p">,</span> |
| <span class="p">},</span> |
| <span class="s1">'compression'</span><span class="p">:</span> <span class="n">compression</span><span class="p">,</span> |
| <span class="s1">'destinationUris'</span><span class="p">:</span> <span class="n">destination_cloud_storage_uris</span><span class="p">,</span> |
| <span class="s1">'destinationFormat'</span><span class="p">:</span> <span class="n">export_format</span><span class="p">,</span> |
| <span class="p">}</span> |
| <span class="p">}</span> |
| |
| <span class="k">if</span> <span class="n">labels</span><span class="p">:</span> |
| <span class="n">configuration</span><span class="p">[</span><span class="s1">'labels'</span><span class="p">]</span> <span class="o">=</span> <span class="n">labels</span> |
| |
| <span class="k">if</span> <span class="n">export_format</span> <span class="o">==</span> <span class="s1">'CSV'</span><span class="p">:</span> |
| <span class="c1"># Only set fieldDelimiter and printHeader fields if using CSV.</span> |
| <span class="c1"># Google does not like it if you set these fields for other export</span> |
| <span class="c1"># formats.</span> |
| <span class="n">configuration</span><span class="p">[</span><span class="s1">'extract'</span><span class="p">][</span><span class="s1">'fieldDelimiter'</span><span class="p">]</span> <span class="o">=</span> <span class="n">field_delimiter</span> |
| <span class="n">configuration</span><span class="p">[</span><span class="s1">'extract'</span><span class="p">][</span><span class="s1">'printHeader'</span><span class="p">]</span> <span class="o">=</span> <span class="n">print_header</span> |
| |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">run_with_configuration</span><span class="p">(</span><span class="n">configuration</span><span class="p">)</span> |
| |
| <span class="k">def</span> <span class="nf">run_copy</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> |
| <span class="n">source_project_dataset_tables</span><span class="p">,</span> |
| <span class="n">destination_project_dataset_table</span><span class="p">,</span> |
| <span class="n">write_disposition</span><span class="o">=</span><span class="s1">'WRITE_EMPTY'</span><span class="p">,</span> |
| <span class="n">create_disposition</span><span class="o">=</span><span class="s1">'CREATE_IF_NEEDED'</span><span class="p">,</span> |
| <span class="n">labels</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Executes a BigQuery copy command to copy data from one BigQuery table</span> |
| <span class="sd"> to another. See here:</span> |
| |
| <span class="sd"> https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.copy</span> |
| |
| <span class="sd"> For more details about these parameters.</span> |
| |
| <span class="sd"> :param source_project_dataset_tables: One or more dotted</span> |
| <span class="sd"> (project:|project.)<dataset>.<table></span> |
| <span class="sd"> BigQuery tables to use as the source data. Use a list if there are</span> |
| <span class="sd"> multiple source tables.</span> |
| <span class="sd"> If <project> is not included, project will be the project defined</span> |
| <span class="sd"> in the connection json.</span> |
| <span class="sd"> :type source_project_dataset_tables: list|string</span> |
| <span class="sd"> :param destination_project_dataset_table: The destination BigQuery</span> |
| <span class="sd"> table. Format is: (project:|project.)<dataset>.<table></span> |
| <span class="sd"> :type destination_project_dataset_table: string</span> |
| <span class="sd"> :param write_disposition: The write disposition if the table already exists.</span> |
| <span class="sd"> :type write_disposition: string</span> |
| <span class="sd"> :param create_disposition: The create disposition if the table doesn't exist.</span> |
| <span class="sd"> :type create_disposition: string</span> |
| <span class="sd"> :param labels a dictionary containing labels for the job/query,</span> |
| <span class="sd"> passed to BigQuery</span> |
| <span class="sd"> :type labels: dict</span> |
| <span class="sd"> """</span> |
| <span class="n">source_project_dataset_tables</span> <span class="o">=</span> <span class="p">([</span> |
| <span class="n">source_project_dataset_tables</span> |
| <span class="p">]</span> <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">source_project_dataset_tables</span><span class="p">,</span> <span class="nb">list</span><span class="p">)</span> <span class="k">else</span> |
| <span class="n">source_project_dataset_tables</span><span class="p">)</span> |
| |
| <span class="n">source_project_dataset_tables_fixup</span> <span class="o">=</span> <span class="p">[]</span> |
| <span class="k">for</span> <span class="n">source_project_dataset_table</span> <span class="ow">in</span> <span class="n">source_project_dataset_tables</span><span class="p">:</span> |
| <span class="n">source_project</span><span class="p">,</span> <span class="n">source_dataset</span><span class="p">,</span> <span class="n">source_table</span> <span class="o">=</span> \ |
| <span class="n">_split_tablename</span><span class="p">(</span><span class="n">table_input</span><span class="o">=</span><span class="n">source_project_dataset_table</span><span class="p">,</span> |
| <span class="n">default_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">var_name</span><span class="o">=</span><span class="s1">'source_project_dataset_table'</span><span class="p">)</span> |
| <span class="n">source_project_dataset_tables_fixup</span><span class="o">.</span><span class="n">append</span><span class="p">({</span> |
| <span class="s1">'projectId'</span><span class="p">:</span> |
| <span class="n">source_project</span><span class="p">,</span> |
| <span class="s1">'datasetId'</span><span class="p">:</span> |
| <span class="n">source_dataset</span><span class="p">,</span> |
| <span class="s1">'tableId'</span><span class="p">:</span> |
| <span class="n">source_table</span> |
| <span class="p">})</span> |
| |
| <span class="n">destination_project</span><span class="p">,</span> <span class="n">destination_dataset</span><span class="p">,</span> <span class="n">destination_table</span> <span class="o">=</span> \ |
| <span class="n">_split_tablename</span><span class="p">(</span><span class="n">table_input</span><span class="o">=</span><span class="n">destination_project_dataset_table</span><span class="p">,</span> |
| <span class="n">default_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">configuration</span> <span class="o">=</span> <span class="p">{</span> |
| <span class="s1">'copy'</span><span class="p">:</span> <span class="p">{</span> |
| <span class="s1">'createDisposition'</span><span class="p">:</span> <span class="n">create_disposition</span><span class="p">,</span> |
| <span class="s1">'writeDisposition'</span><span class="p">:</span> <span class="n">write_disposition</span><span class="p">,</span> |
| <span class="s1">'sourceTables'</span><span class="p">:</span> <span class="n">source_project_dataset_tables_fixup</span><span class="p">,</span> |
| <span class="s1">'destinationTable'</span><span class="p">:</span> <span class="p">{</span> |
| <span class="s1">'projectId'</span><span class="p">:</span> <span class="n">destination_project</span><span class="p">,</span> |
| <span class="s1">'datasetId'</span><span class="p">:</span> <span class="n">destination_dataset</span><span class="p">,</span> |
| <span class="s1">'tableId'</span><span class="p">:</span> <span class="n">destination_table</span> |
| <span class="p">}</span> |
| <span class="p">}</span> |
| <span class="p">}</span> |
| |
| <span class="k">if</span> <span class="n">labels</span><span class="p">:</span> |
| <span class="n">configuration</span><span class="p">[</span><span class="s1">'labels'</span><span class="p">]</span> <span class="o">=</span> <span class="n">labels</span> |
| |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">run_with_configuration</span><span class="p">(</span><span class="n">configuration</span><span class="p">)</span> |
| |
| <span class="k">def</span> <span class="nf">run_load</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> |
| <span class="n">destination_project_dataset_table</span><span class="p">,</span> |
| <span class="n">schema_fields</span><span class="p">,</span> |
| <span class="n">source_uris</span><span class="p">,</span> |
| <span class="n">source_format</span><span class="o">=</span><span class="s1">'CSV'</span><span class="p">,</span> |
| <span class="n">create_disposition</span><span class="o">=</span><span class="s1">'CREATE_IF_NEEDED'</span><span class="p">,</span> |
| <span class="n">skip_leading_rows</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> |
| <span class="n">write_disposition</span><span class="o">=</span><span class="s1">'WRITE_EMPTY'</span><span class="p">,</span> |
| <span class="n">field_delimiter</span><span class="o">=</span><span class="s1">','</span><span class="p">,</span> |
| <span class="n">max_bad_records</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> |
| <span class="n">quote_character</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">ignore_unknown_values</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> |
| <span class="n">allow_quoted_newlines</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> |
| <span class="n">allow_jagged_rows</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> |
| <span class="n">schema_update_options</span><span class="o">=</span><span class="p">(),</span> |
| <span class="n">src_fmt_configs</span><span class="o">=</span><span class="p">{},</span> |
| <span class="n">time_partitioning</span><span class="o">=</span><span class="p">{}):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Executes a BigQuery load command to load data from Google Cloud Storage</span> |
| <span class="sd"> to BigQuery. See here:</span> |
| |
| <span class="sd"> https://cloud.google.com/bigquery/docs/reference/v2/jobs</span> |
| |
| <span class="sd"> For more details about these parameters.</span> |
| |
| <span class="sd"> :param destination_project_dataset_table:</span> |
| <span class="sd"> The dotted (<project>.|<project>:)<dataset>.<table>($<partition>) BigQuery</span> |
| <span class="sd"> table to load data into. If <project> is not included, project will be the</span> |
| <span class="sd"> project defined in the connection json. If a partition is specified the</span> |
| <span class="sd"> operator will automatically append the data, create a new partition or create</span> |
| <span class="sd"> a new DAY partitioned table.</span> |
| <span class="sd"> :type destination_project_dataset_table: string</span> |
| <span class="sd"> :param schema_fields: The schema field list as defined here:</span> |
| <span class="sd"> https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.load</span> |
| <span class="sd"> :type schema_fields: list</span> |
| <span class="sd"> :param source_uris: The source Google Cloud</span> |
| <span class="sd"> Storage URI (e.g. gs://some-bucket/some-file.txt). A single wild</span> |
| <span class="sd"> per-object name can be used.</span> |
| <span class="sd"> :type source_uris: list</span> |
| <span class="sd"> :param source_format: File format to export.</span> |
| <span class="sd"> :type source_format: string</span> |
| <span class="sd"> :param create_disposition: The create disposition if the table doesn't exist.</span> |
| <span class="sd"> :type create_disposition: string</span> |
| <span class="sd"> :param skip_leading_rows: Number of rows to skip when loading from a CSV.</span> |
| <span class="sd"> :type skip_leading_rows: int</span> |
| <span class="sd"> :param write_disposition: The write disposition if the table already exists.</span> |
| <span class="sd"> :type write_disposition: string</span> |
| <span class="sd"> :param field_delimiter: The delimiter to use when loading from a CSV.</span> |
| <span class="sd"> :type field_delimiter: string</span> |
| <span class="sd"> :param max_bad_records: The maximum number of bad records that BigQuery can</span> |
| <span class="sd"> ignore when running the job.</span> |
| <span class="sd"> :type max_bad_records: int</span> |
| <span class="sd"> :param quote_character: The value that is used to quote data sections in a CSV</span> |
| <span class="sd"> file.</span> |
| <span class="sd"> :type quote_character: string</span> |
| <span class="sd"> :param ignore_unknown_values: [Optional] Indicates if BigQuery should allow</span> |
| <span class="sd"> extra values that are not represented in the table schema.</span> |
| <span class="sd"> If true, the extra values are ignored. If false, records with extra columns</span> |
| <span class="sd"> are treated as bad records, and if there are too many bad records, an</span> |
| <span class="sd"> invalid error is returned in the job result.</span> |
| <span class="sd"> :type ignore_unknown_values: bool</span> |
| <span class="sd"> :param allow_quoted_newlines: Whether to allow quoted newlines (true) or not</span> |
| <span class="sd"> (false).</span> |
| <span class="sd"> :type allow_quoted_newlines: boolean</span> |
| <span class="sd"> :param allow_jagged_rows: Accept rows that are missing trailing optional columns.</span> |
| <span class="sd"> The missing values are treated as nulls. If false, records with missing</span> |
| <span class="sd"> trailing columns are treated as bad records, and if there are too many bad</span> |
| <span class="sd"> records, an invalid error is returned in the job result. Only applicable when</span> |
| <span class="sd"> soure_format is CSV.</span> |
| <span class="sd"> :type allow_jagged_rows: bool</span> |
| <span class="sd"> :param schema_update_options: Allows the schema of the desitination</span> |
| <span class="sd"> table to be updated as a side effect of the load job.</span> |
| <span class="sd"> :type schema_update_options: tuple</span> |
| <span class="sd"> :param src_fmt_configs: configure optional fields specific to the source format</span> |
| <span class="sd"> :type src_fmt_configs: dict</span> |
| <span class="sd"> :param time_partitioning: configure optional time partitioning fields i.e.</span> |
| <span class="sd"> partition by field, type and expiration as per API specifications.</span> |
| <span class="sd"> :type time_partitioning: dict</span> |
| <span class="sd"> """</span> |
| |
| <span class="c1"># bigquery only allows certain source formats</span> |
| <span class="c1"># we check to make sure the passed source format is valid</span> |
| <span class="c1"># if it's not, we raise a ValueError</span> |
| <span class="c1"># Refer to this link for more details:</span> |
| <span class="c1"># https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.query.tableDefinitions.(key).sourceFormat</span> |
| <span class="n">source_format</span> <span class="o">=</span> <span class="n">source_format</span><span class="o">.</span><span class="n">upper</span><span class="p">()</span> |
| <span class="n">allowed_formats</span> <span class="o">=</span> <span class="p">[</span> |
| <span class="s2">"CSV"</span><span class="p">,</span> <span class="s2">"NEWLINE_DELIMITED_JSON"</span><span class="p">,</span> <span class="s2">"AVRO"</span><span class="p">,</span> <span class="s2">"GOOGLE_SHEETS"</span><span class="p">,</span> |
| <span class="s2">"DATASTORE_BACKUP"</span><span class="p">,</span> <span class="s2">"PARQUET"</span> |
| <span class="p">]</span> |
| <span class="k">if</span> <span class="n">source_format</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">allowed_formats</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"</span><span class="si">{0}</span><span class="s2"> is not a valid source format. "</span> |
| <span class="s2">"Please use one of the following types: </span><span class="si">{1}</span><span class="s2">"</span> |
| <span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">source_format</span><span class="p">,</span> <span class="n">allowed_formats</span><span class="p">))</span> |
| |
| <span class="c1"># bigquery also allows you to define how you want a table's schema to change</span> |
| <span class="c1"># as a side effect of a load</span> |
| <span class="c1"># for more details:</span> |
| <span class="c1"># https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs#configuration.load.schemaUpdateOptions</span> |
| <span class="n">allowed_schema_update_options</span> <span class="o">=</span> <span class="p">[</span> |
| <span class="s1">'ALLOW_FIELD_ADDITION'</span><span class="p">,</span> <span class="s2">"ALLOW_FIELD_RELAXATION"</span> |
| <span class="p">]</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="nb">set</span><span class="p">(</span><span class="n">allowed_schema_update_options</span><span class="p">)</span><span class="o">.</span><span class="n">issuperset</span><span class="p">(</span> |
| <span class="nb">set</span><span class="p">(</span><span class="n">schema_update_options</span><span class="p">)):</span> |
| <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span> |
| <span class="s2">"</span><span class="si">{0}</span><span class="s2"> contains invalid schema update options. "</span> |
| <span class="s2">"Please only use one or more of the following options: </span><span class="si">{1}</span><span class="s2">"</span> |
| <span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">schema_update_options</span><span class="p">,</span> <span class="n">allowed_schema_update_options</span><span class="p">))</span> |
| |
| <span class="n">destination_project</span><span class="p">,</span> <span class="n">destination_dataset</span><span class="p">,</span> <span class="n">destination_table</span> <span class="o">=</span> \ |
| <span class="n">_split_tablename</span><span class="p">(</span><span class="n">table_input</span><span class="o">=</span><span class="n">destination_project_dataset_table</span><span class="p">,</span> |
| <span class="n">default_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">var_name</span><span class="o">=</span><span class="s1">'destination_project_dataset_table'</span><span class="p">)</span> |
| |
| <span class="n">configuration</span> <span class="o">=</span> <span class="p">{</span> |
| <span class="s1">'load'</span><span class="p">:</span> <span class="p">{</span> |
| <span class="s1">'createDisposition'</span><span class="p">:</span> <span class="n">create_disposition</span><span class="p">,</span> |
| <span class="s1">'destinationTable'</span><span class="p">:</span> <span class="p">{</span> |
| <span class="s1">'projectId'</span><span class="p">:</span> <span class="n">destination_project</span><span class="p">,</span> |
| <span class="s1">'datasetId'</span><span class="p">:</span> <span class="n">destination_dataset</span><span class="p">,</span> |
| <span class="s1">'tableId'</span><span class="p">:</span> <span class="n">destination_table</span><span class="p">,</span> |
| <span class="p">},</span> |
| <span class="s1">'sourceFormat'</span><span class="p">:</span> <span class="n">source_format</span><span class="p">,</span> |
| <span class="s1">'sourceUris'</span><span class="p">:</span> <span class="n">source_uris</span><span class="p">,</span> |
| <span class="s1">'writeDisposition'</span><span class="p">:</span> <span class="n">write_disposition</span><span class="p">,</span> |
| <span class="s1">'ignoreUnknownValues'</span><span class="p">:</span> <span class="n">ignore_unknown_values</span> |
| <span class="p">}</span> |
| <span class="p">}</span> |
| |
| <span class="n">time_partitioning</span> <span class="o">=</span> <span class="n">_cleanse_time_partitioning</span><span class="p">(</span> |
| <span class="n">destination_project_dataset_table</span><span class="p">,</span> |
| <span class="n">time_partitioning</span> |
| <span class="p">)</span> |
| <span class="k">if</span> <span class="n">time_partitioning</span><span class="p">:</span> |
| <span class="n">configuration</span><span class="p">[</span><span class="s1">'load'</span><span class="p">]</span><span class="o">.</span><span class="n">update</span><span class="p">({</span> |
| <span class="s1">'timePartitioning'</span><span class="p">:</span> <span class="n">time_partitioning</span> |
| <span class="p">})</span> |
| |
| <span class="k">if</span> <span class="n">schema_fields</span><span class="p">:</span> |
| <span class="n">configuration</span><span class="p">[</span><span class="s1">'load'</span><span class="p">][</span><span class="s1">'schema'</span><span class="p">]</span> <span class="o">=</span> <span class="p">{</span><span class="s1">'fields'</span><span class="p">:</span> <span class="n">schema_fields</span><span class="p">}</span> |
| |
| <span class="k">if</span> <span class="n">schema_update_options</span><span class="p">:</span> |
| <span class="k">if</span> <span class="n">write_disposition</span> <span class="ow">not</span> <span class="ow">in</span> <span class="p">[</span><span class="s2">"WRITE_APPEND"</span><span class="p">,</span> <span class="s2">"WRITE_TRUNCATE"</span><span class="p">]:</span> |
| <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"schema_update_options is only "</span> |
| <span class="s2">"allowed if write_disposition is "</span> |
| <span class="s2">"'WRITE_APPEND' or 'WRITE_TRUNCATE'."</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">"Adding experimental "</span> |
| <span class="s2">"'schemaUpdateOptions': </span><span class="si">{0}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">schema_update_options</span><span class="p">))</span> |
| <span class="n">configuration</span><span class="p">[</span><span class="s1">'load'</span><span class="p">][</span> |
| <span class="s1">'schemaUpdateOptions'</span><span class="p">]</span> <span class="o">=</span> <span class="n">schema_update_options</span> |
| |
| <span class="k">if</span> <span class="n">max_bad_records</span><span class="p">:</span> |
| <span class="n">configuration</span><span class="p">[</span><span class="s1">'load'</span><span class="p">][</span><span class="s1">'maxBadRecords'</span><span class="p">]</span> <span class="o">=</span> <span class="n">max_bad_records</span> |
| |
| <span class="c1"># if following fields are not specified in src_fmt_configs,</span> |
| <span class="c1"># honor the top-level params for backward-compatibility</span> |
| <span class="k">if</span> <span class="s1">'skipLeadingRows'</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">src_fmt_configs</span><span class="p">:</span> |
| <span class="n">src_fmt_configs</span><span class="p">[</span><span class="s1">'skipLeadingRows'</span><span class="p">]</span> <span class="o">=</span> <span class="n">skip_leading_rows</span> |
| <span class="k">if</span> <span class="s1">'fieldDelimiter'</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">src_fmt_configs</span><span class="p">:</span> |
| <span class="n">src_fmt_configs</span><span class="p">[</span><span class="s1">'fieldDelimiter'</span><span class="p">]</span> <span class="o">=</span> <span class="n">field_delimiter</span> |
| <span class="k">if</span> <span class="s1">'ignoreUnknownValues'</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">src_fmt_configs</span><span class="p">:</span> |
| <span class="n">src_fmt_configs</span><span class="p">[</span><span class="s1">'ignoreUnknownValues'</span><span class="p">]</span> <span class="o">=</span> <span class="n">ignore_unknown_values</span> |
| <span class="k">if</span> <span class="n">quote_character</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="n">src_fmt_configs</span><span class="p">[</span><span class="s1">'quote'</span><span class="p">]</span> <span class="o">=</span> <span class="n">quote_character</span> |
| <span class="k">if</span> <span class="n">allow_quoted_newlines</span><span class="p">:</span> |
| <span class="n">src_fmt_configs</span><span class="p">[</span><span class="s1">'allowQuotedNewlines'</span><span class="p">]</span> <span class="o">=</span> <span class="n">allow_quoted_newlines</span> |
| |
| <span class="n">src_fmt_to_configs_mapping</span> <span class="o">=</span> <span class="p">{</span> |
| <span class="s1">'CSV'</span><span class="p">:</span> <span class="p">[</span> |
| <span class="s1">'allowJaggedRows'</span><span class="p">,</span> <span class="s1">'allowQuotedNewlines'</span><span class="p">,</span> <span class="s1">'autodetect'</span><span class="p">,</span> |
| <span class="s1">'fieldDelimiter'</span><span class="p">,</span> <span class="s1">'skipLeadingRows'</span><span class="p">,</span> <span class="s1">'ignoreUnknownValues'</span><span class="p">,</span> |
| <span class="s1">'nullMarker'</span><span class="p">,</span> <span class="s1">'quote'</span> |
| <span class="p">],</span> |
| <span class="s1">'DATASTORE_BACKUP'</span><span class="p">:</span> <span class="p">[</span><span class="s1">'projectionFields'</span><span class="p">],</span> |
| <span class="s1">'NEWLINE_DELIMITED_JSON'</span><span class="p">:</span> <span class="p">[</span><span class="s1">'autodetect'</span><span class="p">,</span> <span class="s1">'ignoreUnknownValues'</span><span class="p">],</span> |
| <span class="s1">'PARQUET'</span><span class="p">:</span> <span class="p">[</span><span class="s1">'autodetect'</span><span class="p">,</span> <span class="s1">'ignoreUnknownValues'</span><span class="p">],</span> |
| <span class="s1">'AVRO'</span><span class="p">:</span> <span class="p">[],</span> |
| <span class="p">}</span> |
| <span class="n">valid_configs</span> <span class="o">=</span> <span class="n">src_fmt_to_configs_mapping</span><span class="p">[</span><span class="n">source_format</span><span class="p">]</span> |
| <span class="n">src_fmt_configs</span> <span class="o">=</span> <span class="p">{</span> |
| <span class="n">k</span><span class="p">:</span> <span class="n">v</span> |
| <span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">src_fmt_configs</span><span class="o">.</span><span class="n">items</span><span class="p">()</span> <span class="k">if</span> <span class="n">k</span> <span class="ow">in</span> <span class="n">valid_configs</span> |
| <span class="p">}</span> |
| <span class="n">configuration</span><span class="p">[</span><span class="s1">'load'</span><span class="p">]</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">src_fmt_configs</span><span class="p">)</span> |
| |
| <span class="k">if</span> <span class="n">allow_jagged_rows</span><span class="p">:</span> |
| <span class="n">configuration</span><span class="p">[</span><span class="s1">'load'</span><span class="p">][</span><span class="s1">'allowJaggedRows'</span><span class="p">]</span> <span class="o">=</span> <span class="n">allow_jagged_rows</span> |
| |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">run_with_configuration</span><span class="p">(</span><span class="n">configuration</span><span class="p">)</span> |
| |
| <span class="k">def</span> <span class="nf">run_with_configuration</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">configuration</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Executes a BigQuery SQL query. See here:</span> |
| |
| <span class="sd"> https://cloud.google.com/bigquery/docs/reference/v2/jobs</span> |
| |
| <span class="sd"> For more details about the configuration parameter.</span> |
| |
| <span class="sd"> :param configuration: The configuration parameter maps directly to</span> |
| <span class="sd"> BigQuery's configuration field in the job object. See</span> |
| <span class="sd"> https://cloud.google.com/bigquery/docs/reference/v2/jobs for</span> |
| <span class="sd"> details.</span> |
| <span class="sd"> """</span> |
| <span class="n">jobs</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">service</span><span class="o">.</span><span class="n">jobs</span><span class="p">()</span> |
| <span class="n">job_data</span> <span class="o">=</span> <span class="p">{</span><span class="s1">'configuration'</span><span class="p">:</span> <span class="n">configuration</span><span class="p">}</span> |
| |
| <span class="c1"># Send query and wait for reply.</span> |
| <span class="n">query_reply</span> <span class="o">=</span> <span class="n">jobs</span> \ |
| <span class="o">.</span><span class="n">insert</span><span class="p">(</span><span class="n">projectId</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">body</span><span class="o">=</span><span class="n">job_data</span><span class="p">)</span> \ |
| <span class="o">.</span><span class="n">execute</span><span class="p">()</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">running_job_id</span> <span class="o">=</span> <span class="n">query_reply</span><span class="p">[</span><span class="s1">'jobReference'</span><span class="p">][</span><span class="s1">'jobId'</span><span class="p">]</span> |
| |
| <span class="c1"># Wait for query to finish.</span> |
| <span class="n">keep_polling_job</span> <span class="o">=</span> <span class="kc">True</span> |
| <span class="k">while</span> <span class="p">(</span><span class="n">keep_polling_job</span><span class="p">):</span> |
| <span class="k">try</span><span class="p">:</span> |
| <span class="n">job</span> <span class="o">=</span> <span class="n">jobs</span><span class="o">.</span><span class="n">get</span><span class="p">(</span> |
| <span class="n">projectId</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">jobId</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">running_job_id</span><span class="p">)</span><span class="o">.</span><span class="n">execute</span><span class="p">()</span> |
| <span class="k">if</span> <span class="p">(</span><span class="n">job</span><span class="p">[</span><span class="s1">'status'</span><span class="p">][</span><span class="s1">'state'</span><span class="p">]</span> <span class="o">==</span> <span class="s1">'DONE'</span><span class="p">):</span> |
| <span class="n">keep_polling_job</span> <span class="o">=</span> <span class="kc">False</span> |
| <span class="c1"># Check if job had errors.</span> |
| <span class="k">if</span> <span class="s1">'errorResult'</span> <span class="ow">in</span> <span class="n">job</span><span class="p">[</span><span class="s1">'status'</span><span class="p">]:</span> |
| <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span> |
| <span class="s1">'BigQuery job failed. Final error was: </span><span class="si">{}</span><span class="s1">. The job was: </span><span class="si">{}</span><span class="s1">'</span><span class="o">.</span> |
| <span class="nb">format</span><span class="p">(</span><span class="n">job</span><span class="p">[</span><span class="s1">'status'</span><span class="p">][</span><span class="s1">'errorResult'</span><span class="p">],</span> <span class="n">job</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="s1">'Waiting for job to complete : </span><span class="si">%s</span><span class="s1">, </span><span class="si">%s</span><span class="s1">'</span><span class="p">,</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">project_id</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">running_job_id</span><span class="p">)</span> |
| <span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="mi">5</span><span class="p">)</span> |
| |
| <span class="k">except</span> <span class="n">HttpError</span> <span class="k">as</span> <span class="n">err</span><span class="p">:</span> |
| <span class="k">if</span> <span class="n">err</span><span class="o">.</span><span class="n">resp</span><span class="o">.</span><span class="n">status</span> <span class="ow">in</span> <span class="p">[</span><span class="mi">500</span><span class="p">,</span> <span class="mi">503</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="s1">'</span><span class="si">%s</span><span class="s1">: Retryable error, waiting for job to complete: </span><span class="si">%s</span><span class="s1">'</span><span class="p">,</span> |
| <span class="n">err</span><span class="o">.</span><span class="n">resp</span><span class="o">.</span><span class="n">status</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">running_job_id</span><span class="p">)</span> |
| <span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="mi">5</span><span class="p">)</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span> |
| <span class="s1">'BigQuery job status check failed. Final error was: </span><span class="si">%s</span><span class="s1">'</span><span class="p">,</span> |
| <span class="n">err</span><span class="o">.</span><span class="n">resp</span><span class="o">.</span><span class="n">status</span><span class="p">)</span> |
| |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">running_job_id</span> |
| |
| <span class="k">def</span> <span class="nf">poll_job_complete</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">job_id</span><span class="p">):</span> |
| <span class="n">jobs</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">service</span><span class="o">.</span><span class="n">jobs</span><span class="p">()</span> |
| <span class="k">try</span><span class="p">:</span> |
| <span class="n">job</span> <span class="o">=</span> <span class="n">jobs</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">projectId</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">jobId</span><span class="o">=</span><span class="n">job_id</span><span class="p">)</span><span class="o">.</span><span class="n">execute</span><span class="p">()</span> |
| <span class="k">if</span> <span class="p">(</span><span class="n">job</span><span class="p">[</span><span class="s1">'status'</span><span class="p">][</span><span class="s1">'state'</span><span class="p">]</span> <span class="o">==</span> <span class="s1">'DONE'</span><span class="p">):</span> |
| <span class="k">return</span> <span class="kc">True</span> |
| <span class="k">except</span> <span class="n">HttpError</span> <span class="k">as</span> <span class="n">err</span><span class="p">:</span> |
| <span class="k">if</span> <span class="n">err</span><span class="o">.</span><span class="n">resp</span><span class="o">.</span><span class="n">status</span> <span class="ow">in</span> <span class="p">[</span><span class="mi">500</span><span class="p">,</span> <span class="mi">503</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="s1">'</span><span class="si">%s</span><span class="s1">: Retryable error while polling job with id </span><span class="si">%s</span><span class="s1">'</span><span class="p">,</span> |
| <span class="n">err</span><span class="o">.</span><span class="n">resp</span><span class="o">.</span><span class="n">status</span><span class="p">,</span> <span class="n">job_id</span><span class="p">)</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span> |
| <span class="s1">'BigQuery job status check failed. Final error was: </span><span class="si">%s</span><span class="s1">'</span><span class="p">,</span> |
| <span class="n">err</span><span class="o">.</span><span class="n">resp</span><span class="o">.</span><span class="n">status</span><span class="p">)</span> |
| <span class="k">return</span> <span class="kc">False</span> |
| |
| <span class="k">def</span> <span class="nf">cancel_query</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Cancel all started queries that have not yet completed</span> |
| <span class="sd"> """</span> |
| <span class="n">jobs</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">service</span><span class="o">.</span><span class="n">jobs</span><span class="p">()</span> |
| <span class="k">if</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">running_job_id</span> <span class="ow">and</span> |
| <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">poll_job_complete</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">running_job_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="s1">'Attempting to cancel job : </span><span class="si">%s</span><span class="s1">, </span><span class="si">%s</span><span class="s1">'</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">project_id</span><span class="p">,</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">running_job_id</span><span class="p">)</span> |
| <span class="n">jobs</span><span class="o">.</span><span class="n">cancel</span><span class="p">(</span> |
| <span class="n">projectId</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">jobId</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">running_job_id</span><span class="p">)</span><span class="o">.</span><span class="n">execute</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="s1">'No running BigQuery jobs to cancel.'</span><span class="p">)</span> |
| <span class="k">return</span> |
| |
| <span class="c1"># Wait for all the calls to cancel to finish</span> |
| <span class="n">max_polling_attempts</span> <span class="o">=</span> <span class="mi">12</span> |
| <span class="n">polling_attempts</span> <span class="o">=</span> <span class="mi">0</span> |
| |
| <span class="n">job_complete</span> <span class="o">=</span> <span class="kc">False</span> |
| <span class="k">while</span> <span class="p">(</span><span class="n">polling_attempts</span> <span class="o"><</span> <span class="n">max_polling_attempts</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">job_complete</span><span class="p">):</span> |
| <span class="n">polling_attempts</span> <span class="o">=</span> <span class="n">polling_attempts</span> <span class="o">+</span> <span class="mi">1</span> |
| <span class="n">job_complete</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">poll_job_complete</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">running_job_id</span><span class="p">)</span> |
| <span class="k">if</span> <span class="p">(</span><span class="n">job_complete</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="s1">'Job successfully canceled: </span><span class="si">%s</span><span class="s1">, </span><span class="si">%s</span><span class="s1">'</span><span class="p">,</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">project_id</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">running_job_id</span><span class="p">)</span> |
| <span class="k">elif</span> <span class="p">(</span><span class="n">polling_attempts</span> <span class="o">==</span> <span class="n">max_polling_attempts</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">"Stopping polling due to timeout. Job with id </span><span class="si">%s</span><span class="s2"> "</span> |
| <span class="s2">"has not completed cancel and may or may not finish."</span><span class="p">,</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">running_job_id</span><span class="p">)</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s1">'Waiting for canceled job with id </span><span class="si">%s</span><span class="s1"> to finish.'</span><span class="p">,</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">running_job_id</span><span class="p">)</span> |
| <span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="mi">5</span><span class="p">)</span> |
| |
| <span class="k">def</span> <span class="nf">get_schema</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">dataset_id</span><span class="p">,</span> <span class="n">table_id</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Get the schema for a given datset.table.</span> |
| <span class="sd"> see https://cloud.google.com/bigquery/docs/reference/v2/tables#resource</span> |
| |
| <span class="sd"> :param dataset_id: the dataset ID of the requested table</span> |
| <span class="sd"> :param table_id: the table ID of the requested table</span> |
| <span class="sd"> :return: a table schema</span> |
| <span class="sd"> """</span> |
| <span class="n">tables_resource</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">service</span><span class="o">.</span><span class="n">tables</span><span class="p">()</span> \ |
| <span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">projectId</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">datasetId</span><span class="o">=</span><span class="n">dataset_id</span><span class="p">,</span> <span class="n">tableId</span><span class="o">=</span><span class="n">table_id</span><span class="p">)</span> \ |
| <span class="o">.</span><span class="n">execute</span><span class="p">()</span> |
| <span class="k">return</span> <span class="n">tables_resource</span><span class="p">[</span><span class="s1">'schema'</span><span class="p">]</span> |
| |
| <span class="k">def</span> <span class="nf">get_tabledata</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">dataset_id</span><span class="p">,</span> <span class="n">table_id</span><span class="p">,</span> |
| <span class="n">max_results</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">selected_fields</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">page_token</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">start_index</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Get the data of a given dataset.table and optionally with selected columns.</span> |
| <span class="sd"> see https://cloud.google.com/bigquery/docs/reference/v2/tabledata/list</span> |
| |
| <span class="sd"> :param dataset_id: the dataset ID of the requested table.</span> |
| <span class="sd"> :param table_id: the table ID of the requested table.</span> |
| <span class="sd"> :param max_results: the maximum results to return.</span> |
| <span class="sd"> :param selected_fields: List of fields to return (comma-separated). If</span> |
| <span class="sd"> unspecified, all fields are returned.</span> |
| <span class="sd"> :param page_token: page token, returned from a previous call,</span> |
| <span class="sd"> identifying the result set.</span> |
| <span class="sd"> :param start_index: zero based index of the starting row to read.</span> |
| <span class="sd"> :return: map containing the requested rows.</span> |
| <span class="sd"> """</span> |
| <span class="n">optional_params</span> <span class="o">=</span> <span class="p">{}</span> |
| <span class="k">if</span> <span class="n">max_results</span><span class="p">:</span> |
| <span class="n">optional_params</span><span class="p">[</span><span class="s1">'maxResults'</span><span class="p">]</span> <span class="o">=</span> <span class="n">max_results</span> |
| <span class="k">if</span> <span class="n">selected_fields</span><span class="p">:</span> |
| <span class="n">optional_params</span><span class="p">[</span><span class="s1">'selectedFields'</span><span class="p">]</span> <span class="o">=</span> <span class="n">selected_fields</span> |
| <span class="k">if</span> <span class="n">page_token</span><span class="p">:</span> |
| <span class="n">optional_params</span><span class="p">[</span><span class="s1">'pageToken'</span><span class="p">]</span> <span class="o">=</span> <span class="n">page_token</span> |
| <span class="k">if</span> <span class="n">start_index</span><span class="p">:</span> |
| <span class="n">optional_params</span><span class="p">[</span><span class="s1">'startIndex'</span><span class="p">]</span> <span class="o">=</span> <span class="n">start_index</span> |
| <span class="k">return</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">service</span><span class="o">.</span><span class="n">tabledata</span><span class="p">()</span><span class="o">.</span><span class="n">list</span><span class="p">(</span> |
| <span class="n">projectId</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">datasetId</span><span class="o">=</span><span class="n">dataset_id</span><span class="p">,</span> |
| <span class="n">tableId</span><span class="o">=</span><span class="n">table_id</span><span class="p">,</span> |
| <span class="o">**</span><span class="n">optional_params</span><span class="p">)</span><span class="o">.</span><span class="n">execute</span><span class="p">())</span> |
| |
| <span class="k">def</span> <span class="nf">run_table_delete</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">deletion_dataset_table</span><span class="p">,</span> |
| <span class="n">ignore_if_missing</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Delete an existing table from the dataset;</span> |
| <span class="sd"> If the table does not exist, return an error unless ignore_if_missing</span> |
| <span class="sd"> is set to True.</span> |
| |
| <span class="sd"> :param deletion_dataset_table: A dotted</span> |
| <span class="sd"> (<project>.|<project>:)<dataset>.<table> that indicates which table</span> |
| <span class="sd"> will be deleted.</span> |
| <span class="sd"> :type deletion_dataset_table: str</span> |
| <span class="sd"> :param ignore_if_missing: if True, then return success even if the</span> |
| <span class="sd"> requested table does not exist.</span> |
| <span class="sd"> :type ignore_if_missing: boolean</span> |
| <span class="sd"> :return:</span> |
| <span class="sd"> """</span> |
| <span class="k">if</span> <span class="s1">'.'</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">deletion_dataset_table</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span> |
| <span class="s1">'Expected deletion_dataset_table name in the format of '</span> |
| <span class="s1">'<dataset>.<table>. Got: </span><span class="si">{}</span><span class="s1">'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">deletion_dataset_table</span><span class="p">))</span> |
| <span class="n">deletion_project</span><span class="p">,</span> <span class="n">deletion_dataset</span><span class="p">,</span> <span class="n">deletion_table</span> <span class="o">=</span> \ |
| <span class="n">_split_tablename</span><span class="p">(</span><span class="n">table_input</span><span class="o">=</span><span class="n">deletion_dataset_table</span><span class="p">,</span> |
| <span class="n">default_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="k">try</span><span class="p">:</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">service</span><span class="o">.</span><span class="n">tables</span><span class="p">()</span> \ |
| <span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="n">projectId</span><span class="o">=</span><span class="n">deletion_project</span><span class="p">,</span> |
| <span class="n">datasetId</span><span class="o">=</span><span class="n">deletion_dataset</span><span class="p">,</span> |
| <span class="n">tableId</span><span class="o">=</span><span class="n">deletion_table</span><span class="p">)</span> \ |
| <span class="o">.</span><span class="n">execute</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="s1">'Deleted table </span><span class="si">%s</span><span class="s1">:</span><span class="si">%s</span><span class="s1">.</span><span class="si">%s</span><span class="s1">.'</span><span class="p">,</span> <span class="n">deletion_project</span><span class="p">,</span> |
| <span class="n">deletion_dataset</span><span class="p">,</span> <span class="n">deletion_table</span><span class="p">)</span> |
| <span class="k">except</span> <span class="n">HttpError</span><span class="p">:</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="n">ignore_if_missing</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s1">'Table deletion failed. Table does not exist.'</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="s1">'Table does not exist. Skipping.'</span><span class="p">)</span> |
| |
| <span class="k">def</span> <span class="nf">run_table_upsert</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">dataset_id</span><span class="p">,</span> <span class="n">table_resource</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"> creates a new, empty table in the dataset;</span> |
| <span class="sd"> If the table already exists, update the existing table.</span> |
| <span class="sd"> Since BigQuery does not natively allow table upserts, this is not an</span> |
| <span class="sd"> atomic operation.</span> |
| |
| <span class="sd"> :param dataset_id: the dataset to upsert the table into.</span> |
| <span class="sd"> :type dataset_id: str</span> |
| <span class="sd"> :param table_resource: a table resource. see</span> |
| <span class="sd"> https://cloud.google.com/bigquery/docs/reference/v2/tables#resource</span> |
| <span class="sd"> :type table_resource: dict</span> |
| <span class="sd"> :param project_id: the project to upsert the table into. If None,</span> |
| <span class="sd"> project will be self.project_id.</span> |
| <span class="sd"> :return:</span> |
| <span class="sd"> """</span> |
| <span class="c1"># check to see if the table exists</span> |
| <span class="n">table_id</span> <span class="o">=</span> <span class="n">table_resource</span><span class="p">[</span><span class="s1">'tableReference'</span><span class="p">][</span><span class="s1">'tableId'</span><span class="p">]</span> |
| <span class="n">project_id</span> <span class="o">=</span> <span class="n">project_id</span> <span class="k">if</span> <span class="n">project_id</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="k">else</span> <span class="bp">self</span><span class="o">.</span><span class="n">project_id</span> |
| <span class="n">tables_list_resp</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">service</span><span class="o">.</span><span class="n">tables</span><span class="p">()</span><span class="o">.</span><span class="n">list</span><span class="p">(</span> |
| <span class="n">projectId</span><span class="o">=</span><span class="n">project_id</span><span class="p">,</span> <span class="n">datasetId</span><span class="o">=</span><span class="n">dataset_id</span><span class="p">)</span><span class="o">.</span><span class="n">execute</span><span class="p">()</span> |
| <span class="k">while</span> <span class="kc">True</span><span class="p">:</span> |
| <span class="k">for</span> <span class="n">table</span> <span class="ow">in</span> <span class="n">tables_list_resp</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'tables'</span><span class="p">,</span> <span class="p">[]):</span> |
| <span class="k">if</span> <span class="n">table</span><span class="p">[</span><span class="s1">'tableReference'</span><span class="p">][</span><span class="s1">'tableId'</span><span class="p">]</span> <span class="o">==</span> <span class="n">table_id</span><span class="p">:</span> |
| <span class="c1"># found the table, do update</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="s1">'Table </span><span class="si">%s</span><span class="s1">:</span><span class="si">%s</span><span class="s1">.</span><span class="si">%s</span><span class="s1"> exists, updating.'</span><span class="p">,</span> |
| <span class="n">project_id</span><span class="p">,</span> <span class="n">dataset_id</span><span class="p">,</span> <span class="n">table_id</span><span class="p">)</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">service</span><span class="o">.</span><span class="n">tables</span><span class="p">()</span><span class="o">.</span><span class="n">update</span><span class="p">(</span> |
| <span class="n">projectId</span><span class="o">=</span><span class="n">project_id</span><span class="p">,</span> |
| <span class="n">datasetId</span><span class="o">=</span><span class="n">dataset_id</span><span class="p">,</span> |
| <span class="n">tableId</span><span class="o">=</span><span class="n">table_id</span><span class="p">,</span> |
| <span class="n">body</span><span class="o">=</span><span class="n">table_resource</span><span class="p">)</span><span class="o">.</span><span class="n">execute</span><span class="p">()</span> |
| <span class="c1"># If there is a next page, we need to check the next page.</span> |
| <span class="k">if</span> <span class="s1">'nextPageToken'</span> <span class="ow">in</span> <span class="n">tables_list_resp</span><span class="p">:</span> |
| <span class="n">tables_list_resp</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">service</span><span class="o">.</span><span class="n">tables</span><span class="p">()</span>\ |
| <span class="o">.</span><span class="n">list</span><span class="p">(</span><span class="n">projectId</span><span class="o">=</span><span class="n">project_id</span><span class="p">,</span> |
| <span class="n">datasetId</span><span class="o">=</span><span class="n">dataset_id</span><span class="p">,</span> |
| <span class="n">pageToken</span><span class="o">=</span><span class="n">tables_list_resp</span><span class="p">[</span><span class="s1">'nextPageToken'</span><span class="p">])</span>\ |
| <span class="o">.</span><span class="n">execute</span><span class="p">()</span> |
| <span class="c1"># If there is no next page, then the table doesn't exist.</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="c1"># do insert</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="s1">'Table </span><span class="si">%s</span><span class="s1">:</span><span class="si">%s</span><span class="s1">.</span><span class="si">%s</span><span class="s1"> does not exist. creating.'</span><span class="p">,</span> |
| <span class="n">project_id</span><span class="p">,</span> <span class="n">dataset_id</span><span class="p">,</span> <span class="n">table_id</span><span class="p">)</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">service</span><span class="o">.</span><span class="n">tables</span><span class="p">()</span><span class="o">.</span><span class="n">insert</span><span class="p">(</span> |
| <span class="n">projectId</span><span class="o">=</span><span class="n">project_id</span><span class="p">,</span> |
| <span class="n">datasetId</span><span class="o">=</span><span class="n">dataset_id</span><span class="p">,</span> |
| <span class="n">body</span><span class="o">=</span><span class="n">table_resource</span><span class="p">)</span><span class="o">.</span><span class="n">execute</span><span class="p">()</span> |
| |
| <span class="k">def</span> <span class="nf">run_grant_dataset_view_access</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> |
| <span class="n">source_dataset</span><span class="p">,</span> |
| <span class="n">view_dataset</span><span class="p">,</span> |
| <span class="n">view_table</span><span class="p">,</span> |
| <span class="n">source_project</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">view_project</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Grant authorized view access of a dataset to a view table.</span> |
| <span class="sd"> If this view has already been granted access to the dataset, do nothing.</span> |
| <span class="sd"> This method is not atomic. Running it may clobber a simultaneous update.</span> |
| |
| <span class="sd"> :param source_dataset: the source dataset</span> |
| <span class="sd"> :type source_dataset: str</span> |
| <span class="sd"> :param view_dataset: the dataset that the view is in</span> |
| <span class="sd"> :type view_dataset: str</span> |
| <span class="sd"> :param view_table: the table of the view</span> |
| <span class="sd"> :type view_table: str</span> |
| <span class="sd"> :param source_project: the project of the source dataset. If None,</span> |
| <span class="sd"> self.project_id will be used.</span> |
| <span class="sd"> :type source_project: str</span> |
| <span class="sd"> :param view_project: the project that the view is in. If None,</span> |
| <span class="sd"> self.project_id will be used.</span> |
| <span class="sd"> :type view_project: str</span> |
| <span class="sd"> :return: the datasets resource of the source dataset.</span> |
| <span class="sd"> """</span> |
| |
| <span class="c1"># Apply default values to projects</span> |
| <span class="n">source_project</span> <span class="o">=</span> <span class="n">source_project</span> <span class="k">if</span> <span class="n">source_project</span> <span class="k">else</span> <span class="bp">self</span><span class="o">.</span><span class="n">project_id</span> |
| <span class="n">view_project</span> <span class="o">=</span> <span class="n">view_project</span> <span class="k">if</span> <span class="n">view_project</span> <span class="k">else</span> <span class="bp">self</span><span class="o">.</span><span class="n">project_id</span> |
| |
| <span class="c1"># we don't want to clobber any existing accesses, so we have to get</span> |
| <span class="c1"># info on the dataset before we can add view access</span> |
| <span class="n">source_dataset_resource</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">service</span><span class="o">.</span><span class="n">datasets</span><span class="p">()</span><span class="o">.</span><span class="n">get</span><span class="p">(</span> |
| <span class="n">projectId</span><span class="o">=</span><span class="n">source_project</span><span class="p">,</span> <span class="n">datasetId</span><span class="o">=</span><span class="n">source_dataset</span><span class="p">)</span><span class="o">.</span><span class="n">execute</span><span class="p">()</span> |
| <span class="n">access</span> <span class="o">=</span> <span class="n">source_dataset_resource</span><span class="p">[</span> |
| <span class="s1">'access'</span><span class="p">]</span> <span class="k">if</span> <span class="s1">'access'</span> <span class="ow">in</span> <span class="n">source_dataset_resource</span> <span class="k">else</span> <span class="p">[]</span> |
| <span class="n">view_access</span> <span class="o">=</span> <span class="p">{</span> |
| <span class="s1">'view'</span><span class="p">:</span> <span class="p">{</span> |
| <span class="s1">'projectId'</span><span class="p">:</span> <span class="n">view_project</span><span class="p">,</span> |
| <span class="s1">'datasetId'</span><span class="p">:</span> <span class="n">view_dataset</span><span class="p">,</span> |
| <span class="s1">'tableId'</span><span class="p">:</span> <span class="n">view_table</span> |
| <span class="p">}</span> |
| <span class="p">}</span> |
| <span class="c1"># check to see if the view we want to add already exists.</span> |
| <span class="k">if</span> <span class="n">view_access</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">access</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="s1">'Granting table </span><span class="si">%s</span><span class="s1">:</span><span class="si">%s</span><span class="s1">.</span><span class="si">%s</span><span class="s1"> authorized view access to </span><span class="si">%s</span><span class="s1">:</span><span class="si">%s</span><span class="s1"> dataset.'</span><span class="p">,</span> |
| <span class="n">view_project</span><span class="p">,</span> <span class="n">view_dataset</span><span class="p">,</span> <span class="n">view_table</span><span class="p">,</span> <span class="n">source_project</span><span class="p">,</span> |
| <span class="n">source_dataset</span><span class="p">)</span> |
| <span class="n">access</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">view_access</span><span class="p">)</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">service</span><span class="o">.</span><span class="n">datasets</span><span class="p">()</span><span class="o">.</span><span class="n">patch</span><span class="p">(</span> |
| <span class="n">projectId</span><span class="o">=</span><span class="n">source_project</span><span class="p">,</span> |
| <span class="n">datasetId</span><span class="o">=</span><span class="n">source_dataset</span><span class="p">,</span> |
| <span class="n">body</span><span class="o">=</span><span class="p">{</span> |
| <span class="s1">'access'</span><span class="p">:</span> <span class="n">access</span> |
| <span class="p">})</span><span class="o">.</span><span class="n">execute</span><span class="p">()</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="c1"># if view is already in access, do nothing.</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="s1">'Table </span><span class="si">%s</span><span class="s1">:</span><span class="si">%s</span><span class="s1">.</span><span class="si">%s</span><span class="s1"> already has authorized view access to </span><span class="si">%s</span><span class="s1">:</span><span class="si">%s</span><span class="s1"> dataset.'</span><span class="p">,</span> |
| <span class="n">view_project</span><span class="p">,</span> <span class="n">view_dataset</span><span class="p">,</span> <span class="n">view_table</span><span class="p">,</span> <span class="n">source_project</span><span class="p">,</span> <span class="n">source_dataset</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">source_dataset_resource</span> |
| |
| <span class="k">def</span> <span class="nf">delete_dataset</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">project_id</span><span class="p">,</span> <span class="n">dataset_id</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Delete a dataset of Big query in your project.</span> |
| <span class="sd"> :param project_id: The name of the project where we have the dataset .</span> |
| <span class="sd"> :type project_id: str</span> |
| <span class="sd"> :param dataset_id: The dataset to be delete.</span> |
| <span class="sd"> :type dataset_id: str</span> |
| <span class="sd"> :return:</span> |
| <span class="sd"> """</span> |
| <span class="n">project_id</span> <span class="o">=</span> <span class="n">project_id</span> <span class="k">if</span> <span class="n">project_id</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="k">else</span> <span class="bp">self</span><span class="o">.</span><span class="n">project_id</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="s1">'Deleting from project: </span><span class="si">%s</span><span class="s1"> Dataset:</span><span class="si">%s</span><span class="s1">'</span><span class="p">,</span> |
| <span class="n">project_id</span><span class="p">,</span> <span class="n">dataset_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">service</span><span class="o">.</span><span class="n">datasets</span><span class="p">()</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span> |
| <span class="n">projectId</span><span class="o">=</span><span class="n">project_id</span><span class="p">,</span> |
| <span class="n">datasetId</span><span class="o">=</span><span class="n">dataset_id</span><span class="p">)</span><span class="o">.</span><span class="n">execute</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="s1">'Dataset deleted successfully: In project </span><span class="si">%s</span><span class="s1"> '</span> |
| <span class="s1">'Dataset </span><span class="si">%s</span><span class="s1">'</span><span class="p">,</span> <span class="n">project_id</span><span class="p">,</span> <span class="n">dataset_id</span><span class="p">)</span> |
| |
| <span class="k">except</span> <span class="n">HttpError</span> <span class="k">as</span> <span class="n">err</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span> |
| <span class="s1">'BigQuery job failed. Error was: </span><span class="si">{}</span><span class="s1">'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">err</span><span class="o">.</span><span class="n">content</span><span class="p">)</span> |
| <span class="p">)</span> |
| |
| |
| <span class="k">class</span> <span class="nc">BigQueryCursor</span><span class="p">(</span><span class="n">BigQueryBaseCursor</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> A very basic BigQuery PEP 249 cursor implementation. The PyHive PEP 249</span> |
| <span class="sd"> implementation was used as a reference:</span> |
| |
| <span class="sd"> https://github.com/dropbox/PyHive/blob/master/pyhive/presto.py</span> |
| <span class="sd"> https://github.com/dropbox/PyHive/blob/master/pyhive/common.py</span> |
| <span class="sd"> """</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">service</span><span class="p">,</span> <span class="n">project_id</span><span class="p">,</span> <span class="n">use_legacy_sql</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span> |
| <span class="nb">super</span><span class="p">(</span><span class="n">BigQueryCursor</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">service</span><span class="o">=</span><span class="n">service</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">use_legacy_sql</span><span class="o">=</span><span class="n">use_legacy_sql</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">buffersize</span> <span class="o">=</span> <span class="kc">None</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">page_token</span> <span class="o">=</span> <span class="kc">None</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">job_id</span> <span class="o">=</span> <span class="kc">None</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">buffer</span> <span class="o">=</span> <span class="p">[]</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">all_pages_loaded</span> <span class="o">=</span> <span class="kc">False</span> |
| |
| <span class="nd">@property</span> |
| <span class="k">def</span> <span class="nf">description</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="sd">""" The schema description method is not currently implemented. """</span> |
| <span class="k">raise</span> <span class="ne">NotImplementedError</span> |
| |
| <span class="k">def</span> <span class="nf">close</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="sd">""" By default, do nothing """</span> |
| <span class="k">pass</span> |
| |
| <span class="nd">@property</span> |
| <span class="k">def</span> <span class="nf">rowcount</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="sd">""" By default, return -1 to indicate that this is not supported. """</span> |
| <span class="k">return</span> <span class="o">-</span><span class="mi">1</span> |
| |
| <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">operation</span><span class="p">,</span> <span class="n">parameters</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Executes a BigQuery query, and returns the job ID.</span> |
| |
| <span class="sd"> :param operation: The query to execute.</span> |
| <span class="sd"> :type operation: string</span> |
| <span class="sd"> :param parameters: Parameters to substitute into the query.</span> |
| <span class="sd"> :type parameters: dict</span> |
| <span class="sd"> """</span> |
| <span class="n">sql</span> <span class="o">=</span> <span class="n">_bind_parameters</span><span class="p">(</span><span class="n">operation</span><span class="p">,</span> |
| <span class="n">parameters</span><span class="p">)</span> <span class="k">if</span> <span class="n">parameters</span> <span class="k">else</span> <span class="n">operation</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">job_id</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">run_query</span><span class="p">(</span><span class="n">sql</span><span class="p">)</span> |
| |
| <span class="k">def</span> <span class="nf">executemany</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">operation</span><span class="p">,</span> <span class="n">seq_of_parameters</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Execute a BigQuery query multiple times with different parameters.</span> |
| |
| <span class="sd"> :param operation: The query to execute.</span> |
| <span class="sd"> :type operation: string</span> |
| <span class="sd"> :param seq_of_parameters: List of dictionary parameters to substitute into the</span> |
| <span class="sd"> query.</span> |
| <span class="sd"> :type seq_of_parameters: list</span> |
| <span class="sd"> """</span> |
| <span class="k">for</span> <span class="n">parameters</span> <span class="ow">in</span> <span class="n">seq_of_parameters</span><span class="p">:</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">operation</span><span class="p">,</span> <span class="n">parameters</span><span class="p">)</span> |
| |
| <span class="k">def</span> <span class="nf">fetchone</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="sd">""" Fetch the next row of a query result set. """</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">next</span><span class="p">()</span> |
| |
| <span class="k">def</span> <span class="nf">next</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Helper method for fetchone, which returns the next row from a buffer.</span> |
| <span class="sd"> If the buffer is empty, attempts to paginate through the result set for</span> |
| <span class="sd"> the next page, and load it into the buffer.</span> |
| <span class="sd"> """</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">job_id</span><span class="p">:</span> |
| <span class="k">return</span> <span class="kc">None</span> |
| |
| <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">buffer</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span> |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">all_pages_loaded</span><span class="p">:</span> |
| <span class="k">return</span> <span class="kc">None</span> |
| |
| <span class="n">query_results</span> <span class="o">=</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">service</span><span class="o">.</span><span class="n">jobs</span><span class="p">()</span><span class="o">.</span><span class="n">getQueryResults</span><span class="p">(</span> |
| <span class="n">projectId</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">jobId</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">job_id</span><span class="p">,</span> |
| <span class="n">pageToken</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">page_token</span><span class="p">)</span><span class="o">.</span><span class="n">execute</span><span class="p">())</span> |
| |
| <span class="k">if</span> <span class="s1">'rows'</span> <span class="ow">in</span> <span class="n">query_results</span> <span class="ow">and</span> <span class="n">query_results</span><span class="p">[</span><span class="s1">'rows'</span><span class="p">]:</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">page_token</span> <span class="o">=</span> <span class="n">query_results</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'pageToken'</span><span class="p">)</span> |
| <span class="n">fields</span> <span class="o">=</span> <span class="n">query_results</span><span class="p">[</span><span class="s1">'schema'</span><span class="p">][</span><span class="s1">'fields'</span><span class="p">]</span> |
| <span class="n">col_types</span> <span class="o">=</span> <span class="p">[</span><span class="n">field</span><span class="p">[</span><span class="s1">'type'</span><span class="p">]</span> <span class="k">for</span> <span class="n">field</span> <span class="ow">in</span> <span class="n">fields</span><span class="p">]</span> |
| <span class="n">rows</span> <span class="o">=</span> <span class="n">query_results</span><span class="p">[</span><span class="s1">'rows'</span><span class="p">]</span> |
| |
| <span class="k">for</span> <span class="n">dict_row</span> <span class="ow">in</span> <span class="n">rows</span><span class="p">:</span> |
| <span class="n">typed_row</span> <span class="o">=</span> <span class="p">([</span> |
| <span class="n">_bq_cast</span><span class="p">(</span><span class="n">vs</span><span class="p">[</span><span class="s1">'v'</span><span class="p">],</span> <span class="n">col_types</span><span class="p">[</span><span class="n">idx</span><span class="p">])</span> |
| <span class="k">for</span> <span class="n">idx</span><span class="p">,</span> <span class="n">vs</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">dict_row</span><span class="p">[</span><span class="s1">'f'</span><span class="p">])</span> |
| <span class="p">])</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">buffer</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">typed_row</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">page_token</span><span class="p">:</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">all_pages_loaded</span> <span class="o">=</span> <span class="kc">True</span> |
| |
| <span class="k">else</span><span class="p">:</span> |
| <span class="c1"># Reset all state since we've exhausted the results.</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">page_token</span> <span class="o">=</span> <span class="kc">None</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">job_id</span> <span class="o">=</span> <span class="kc">None</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">page_token</span> <span class="o">=</span> <span class="kc">None</span> |
| <span class="k">return</span> <span class="kc">None</span> |
| |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">buffer</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span> |
| |
| <span class="k">def</span> <span class="nf">fetchmany</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">size</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Fetch the next set of rows of a query result, returning a sequence of sequences</span> |
| <span class="sd"> (e.g. a list of tuples). An empty sequence is returned when no more rows are</span> |
| <span class="sd"> available. The number of rows to fetch per call is specified by the parameter.</span> |
| <span class="sd"> If it is not given, the cursor's arraysize determines the number of rows to be</span> |
| <span class="sd"> fetched. The method should try to fetch as many rows as indicated by the size</span> |
| <span class="sd"> parameter. If this is not possible due to the specified number of rows not being</span> |
| <span class="sd"> available, fewer rows may be returned. An :py:class:`~pyhive.exc.Error`</span> |
| <span class="sd"> (or subclass) exception is raised if the previous call to</span> |
| <span class="sd"> :py:meth:`execute` did not produce any result set or no call was issued yet.</span> |
| <span class="sd"> """</span> |
| <span class="k">if</span> <span class="n">size</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="n">size</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">arraysize</span> |
| <span class="n">result</span> <span class="o">=</span> <span class="p">[]</span> |
| <span class="k">for</span> <span class="n">_</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">size</span><span class="p">):</span> |
| <span class="n">one</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">fetchone</span><span class="p">()</span> |
| <span class="k">if</span> <span class="n">one</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="k">break</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="n">result</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">one</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">result</span> |
| |
| <span class="k">def</span> <span class="nf">fetchall</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Fetch all (remaining) rows of a query result, returning them as a sequence of</span> |
| <span class="sd"> sequences (e.g. a list of tuples).</span> |
| <span class="sd"> """</span> |
| <span class="n">result</span> <span class="o">=</span> <span class="p">[]</span> |
| <span class="k">while</span> <span class="kc">True</span><span class="p">:</span> |
| <span class="n">one</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">fetchone</span><span class="p">()</span> |
| <span class="k">if</span> <span class="n">one</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="k">break</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="n">result</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">one</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">result</span> |
| |
| <span class="k">def</span> <span class="nf">get_arraysize</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="sd">""" Specifies the number of rows to fetch at a time with .fetchmany() """</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_buffersize</span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">buffersize</span> <span class="k">else</span> <span class="mi">1</span> |
| |
| <span class="k">def</span> <span class="nf">set_arraysize</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">arraysize</span><span class="p">):</span> |
| <span class="sd">""" Specifies the number of rows to fetch at a time with .fetchmany() """</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">buffersize</span> <span class="o">=</span> <span class="n">arraysize</span> |
| |
| <span class="n">arraysize</span> <span class="o">=</span> <span class="nb">property</span><span class="p">(</span><span class="n">get_arraysize</span><span class="p">,</span> <span class="n">set_arraysize</span><span class="p">)</span> |
| |
| <span class="k">def</span> <span class="nf">setinputsizes</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">sizes</span><span class="p">):</span> |
| <span class="sd">""" Does nothing by default """</span> |
| <span class="k">pass</span> |
| |
| <span class="k">def</span> <span class="nf">setoutputsize</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">size</span><span class="p">,</span> <span class="n">column</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="sd">""" Does nothing by default """</span> |
| <span class="k">pass</span> |
| |
| |
| <span class="k">def</span> <span class="nf">_bind_parameters</span><span class="p">(</span><span class="n">operation</span><span class="p">,</span> <span class="n">parameters</span><span class="p">):</span> |
| <span class="sd">""" Helper method that binds parameters to a SQL query. """</span> |
| <span class="c1"># inspired by MySQL Python Connector (conversion.py)</span> |
| <span class="n">string_parameters</span> <span class="o">=</span> <span class="p">{}</span> |
| <span class="k">for</span> <span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span> <span class="ow">in</span> <span class="n">parameters</span><span class="o">.</span><span class="n">iteritems</span><span class="p">():</span> |
| <span class="k">if</span> <span class="n">value</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="n">string_parameters</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="s1">'NULL'</span> |
| <span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">basestring</span><span class="p">):</span> |
| <span class="n">string_parameters</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"'"</span> <span class="o">+</span> <span class="n">_escape</span><span class="p">(</span><span class="n">value</span><span class="p">)</span> <span class="o">+</span> <span class="s2">"'"</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="n">string_parameters</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">operation</span> <span class="o">%</span> <span class="n">string_parameters</span> |
| |
| |
| <span class="k">def</span> <span class="nf">_escape</span><span class="p">(</span><span class="n">s</span><span class="p">):</span> |
| <span class="sd">""" Helper method that escapes parameters to a SQL query. """</span> |
| <span class="n">e</span> <span class="o">=</span> <span class="n">s</span> |
| <span class="n">e</span> <span class="o">=</span> <span class="n">e</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'</span><span class="se">\\</span><span class="s1">'</span><span class="p">,</span> <span class="s1">'</span><span class="se">\\\\</span><span class="s1">'</span><span class="p">)</span> |
| <span class="n">e</span> <span class="o">=</span> <span class="n">e</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="p">,</span> <span class="s1">'</span><span class="se">\\</span><span class="s1">n'</span><span class="p">)</span> |
| <span class="n">e</span> <span class="o">=</span> <span class="n">e</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'</span><span class="se">\r</span><span class="s1">'</span><span class="p">,</span> <span class="s1">'</span><span class="se">\\</span><span class="s1">r'</span><span class="p">)</span> |
| <span class="n">e</span> <span class="o">=</span> <span class="n">e</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s2">"'"</span><span class="p">,</span> <span class="s2">"</span><span class="se">\\</span><span class="s2">'"</span><span class="p">)</span> |
| <span class="n">e</span> <span class="o">=</span> <span class="n">e</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'"'</span><span class="p">,</span> <span class="s1">'</span><span class="se">\\</span><span class="s1">"'</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">e</span> |
| |
| |
| <span class="k">def</span> <span class="nf">_bq_cast</span><span class="p">(</span><span class="n">string_field</span><span class="p">,</span> <span class="n">bq_type</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Helper method that casts a BigQuery row to the appropriate data types.</span> |
| <span class="sd"> This is useful because BigQuery returns all fields as strings.</span> |
| <span class="sd"> """</span> |
| <span class="k">if</span> <span class="n">string_field</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="k">return</span> <span class="kc">None</span> |
| <span class="k">elif</span> <span class="n">bq_type</span> <span class="o">==</span> <span class="s1">'INTEGER'</span><span class="p">:</span> |
| <span class="k">return</span> <span class="nb">int</span><span class="p">(</span><span class="n">string_field</span><span class="p">)</span> |
| <span class="k">elif</span> <span class="n">bq_type</span> <span class="o">==</span> <span class="s1">'FLOAT'</span> <span class="ow">or</span> <span class="n">bq_type</span> <span class="o">==</span> <span class="s1">'TIMESTAMP'</span><span class="p">:</span> |
| <span class="k">return</span> <span class="nb">float</span><span class="p">(</span><span class="n">string_field</span><span class="p">)</span> |
| <span class="k">elif</span> <span class="n">bq_type</span> <span class="o">==</span> <span class="s1">'BOOLEAN'</span><span class="p">:</span> |
| <span class="k">if</span> <span class="n">string_field</span> <span class="ow">not</span> <span class="ow">in</span> <span class="p">[</span><span class="s1">'true'</span><span class="p">,</span> <span class="s1">'false'</span><span class="p">]:</span> |
| <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"</span><span class="si">{}</span><span class="s2"> must have value 'true' or 'false'"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span> |
| <span class="n">string_field</span><span class="p">))</span> |
| <span class="k">return</span> <span class="n">string_field</span> <span class="o">==</span> <span class="s1">'true'</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="k">return</span> <span class="n">string_field</span> |
| |
| |
| <span class="k">def</span> <span class="nf">_split_tablename</span><span class="p">(</span><span class="n">table_input</span><span class="p">,</span> <span class="n">default_project_id</span><span class="p">,</span> <span class="n">var_name</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="n">default_project_id</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"INTERNAL: No default project is specified"</span><span class="p">)</span> |
| |
| <span class="k">def</span> <span class="nf">var_print</span><span class="p">(</span><span class="n">var_name</span><span class="p">):</span> |
| <span class="k">if</span> <span class="n">var_name</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="k">return</span> <span class="s2">""</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="k">return</span> <span class="s2">"Format exception for </span><span class="si">{var}</span><span class="s2">: "</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">var</span><span class="o">=</span><span class="n">var_name</span><span class="p">)</span> |
| |
| <span class="k">if</span> <span class="n">table_input</span><span class="o">.</span><span class="n">count</span><span class="p">(</span><span class="s1">'.'</span><span class="p">)</span> <span class="o">+</span> <span class="n">table_input</span><span class="o">.</span><span class="n">count</span><span class="p">(</span><span class="s1">':'</span><span class="p">)</span> <span class="o">></span> <span class="mi">3</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="ne">Exception</span><span class="p">((</span><span class="s1">'</span><span class="si">{var}</span><span class="s1">Use either : or . to specify project '</span> |
| <span class="s1">'got </span><span class="si">{input}</span><span class="s1">'</span><span class="p">)</span><span class="o">.</span><span class="n">format</span><span class="p">(</span> |
| <span class="n">var</span><span class="o">=</span><span class="n">var_print</span><span class="p">(</span><span class="n">var_name</span><span class="p">),</span> <span class="nb">input</span><span class="o">=</span><span class="n">table_input</span><span class="p">))</span> |
| <span class="n">cmpt</span> <span class="o">=</span> <span class="n">table_input</span><span class="o">.</span><span class="n">rsplit</span><span class="p">(</span><span class="s1">':'</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span> |
| <span class="n">project_id</span> <span class="o">=</span> <span class="kc">None</span> |
| <span class="n">rest</span> <span class="o">=</span> <span class="n">table_input</span> |
| <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">cmpt</span><span class="p">)</span> <span class="o">==</span> <span class="mi">1</span><span class="p">:</span> |
| <span class="n">project_id</span> <span class="o">=</span> <span class="kc">None</span> |
| <span class="n">rest</span> <span class="o">=</span> <span class="n">cmpt</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> |
| <span class="k">elif</span> <span class="nb">len</span><span class="p">(</span><span class="n">cmpt</span><span class="p">)</span> <span class="o">==</span> <span class="mi">2</span> <span class="ow">and</span> <span class="n">cmpt</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">count</span><span class="p">(</span><span class="s1">':'</span><span class="p">)</span> <span class="o"><=</span> <span class="mi">1</span><span class="p">:</span> |
| <span class="k">if</span> <span class="n">cmpt</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">count</span><span class="p">(</span><span class="s1">'.'</span><span class="p">)</span> <span class="o">!=</span> <span class="mi">2</span><span class="p">:</span> |
| <span class="n">project_id</span> <span class="o">=</span> <span class="n">cmpt</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> |
| <span class="n">rest</span> <span class="o">=</span> <span class="n">cmpt</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="ne">Exception</span><span class="p">((</span><span class="s1">'</span><span class="si">{var}</span><span class="s1">Expect format of (<project:)<dataset>.<table>, '</span> |
| <span class="s1">'got </span><span class="si">{input}</span><span class="s1">'</span><span class="p">)</span><span class="o">.</span><span class="n">format</span><span class="p">(</span> |
| <span class="n">var</span><span class="o">=</span><span class="n">var_print</span><span class="p">(</span><span class="n">var_name</span><span class="p">),</span> <span class="nb">input</span><span class="o">=</span><span class="n">table_input</span><span class="p">))</span> |
| |
| <span class="n">cmpt</span> <span class="o">=</span> <span class="n">rest</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">'.'</span><span class="p">)</span> |
| <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">cmpt</span><span class="p">)</span> <span class="o">==</span> <span class="mi">3</span><span class="p">:</span> |
| <span class="k">if</span> <span class="n">project_id</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span> |
| <span class="s2">"</span><span class="si">{var}</span><span class="s2">Use either : or . to specify project"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span> |
| <span class="n">var</span><span class="o">=</span><span class="n">var_print</span><span class="p">(</span><span class="n">var_name</span><span class="p">)))</span> |
| <span class="n">project_id</span> <span class="o">=</span> <span class="n">cmpt</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> |
| <span class="n">dataset_id</span> <span class="o">=</span> <span class="n">cmpt</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> |
| <span class="n">table_id</span> <span class="o">=</span> <span class="n">cmpt</span><span class="p">[</span><span class="mi">2</span><span class="p">]</span> |
| |
| <span class="k">elif</span> <span class="nb">len</span><span class="p">(</span><span class="n">cmpt</span><span class="p">)</span> <span class="o">==</span> <span class="mi">2</span><span class="p">:</span> |
| <span class="n">dataset_id</span> <span class="o">=</span> <span class="n">cmpt</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> |
| <span class="n">table_id</span> <span class="o">=</span> <span class="n">cmpt</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span> |
| <span class="p">(</span><span class="s1">'</span><span class="si">{var}</span><span class="s1">Expect format of (<project.|<project:)<dataset>.<table>, '</span> |
| <span class="s1">'got </span><span class="si">{input}</span><span class="s1">'</span><span class="p">)</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">var</span><span class="o">=</span><span class="n">var_print</span><span class="p">(</span><span class="n">var_name</span><span class="p">),</span> <span class="nb">input</span><span class="o">=</span><span class="n">table_input</span><span class="p">))</span> |
| |
| <span class="k">if</span> <span class="n">project_id</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="k">if</span> <span class="n">var_name</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="n">log</span> <span class="o">=</span> <span class="n">LoggingMixin</span><span class="p">()</span><span class="o">.</span><span class="n">log</span> |
| <span class="n">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s1">'Project not included in </span><span class="si">{var}</span><span class="s1">: </span><span class="si">{input}</span><span class="s1">; '</span> |
| <span class="s1">'using project "</span><span class="si">{project}</span><span class="s1">"'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span> |
| <span class="n">var</span><span class="o">=</span><span class="n">var_name</span><span class="p">,</span> |
| <span class="nb">input</span><span class="o">=</span><span class="n">table_input</span><span class="p">,</span> |
| <span class="n">project</span><span class="o">=</span><span class="n">default_project_id</span><span class="p">))</span> |
| <span class="n">project_id</span> <span class="o">=</span> <span class="n">default_project_id</span> |
| |
| <span class="k">return</span> <span class="n">project_id</span><span class="p">,</span> <span class="n">dataset_id</span><span class="p">,</span> <span class="n">table_id</span> |
| |
| |
| <span class="k">def</span> <span class="nf">_cleanse_time_partitioning</span><span class="p">(</span><span class="n">destination_dataset_table</span><span class="p">,</span> <span class="n">time_partitioning_in</span><span class="p">):</span> |
| <span class="c1"># if it is a partitioned table ($ is in the table name) add partition load option</span> |
| <span class="n">time_partitioning_out</span> <span class="o">=</span> <span class="p">{}</span> |
| <span class="k">if</span> <span class="n">destination_dataset_table</span> <span class="ow">and</span> <span class="s1">'$'</span> <span class="ow">in</span> <span class="n">destination_dataset_table</span><span class="p">:</span> |
| <span class="n">time_partitioning_out</span><span class="p">[</span><span class="s1">'type'</span><span class="p">]</span> <span class="o">=</span> <span class="s1">'DAY'</span> |
| <span class="n">time_partitioning_out</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">time_partitioning_in</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">time_partitioning_out</span> |
| </pre></div> |
| |
| </div> |
| |
| </div> |
| <footer> |
| |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p> |
| |
| </p> |
| </div> |
| Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. |
| |
| </footer> |
| |
| </div> |
| </div> |
| |
| </section> |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| <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/js/theme.js"></script> |
| |
| <script type="text/javascript"> |
| jQuery(function () { |
| SphinxRtdTheme.Navigation.enable(true); |
| }); |
| </script> |
| |
| </body> |
| </html> |