Google Git
Sign in
apache / beam-site / aa4899384bfb3460196adf6331c744cb480b96df / . / pydoc / 2.38.0 / _modules / apache_beam / io / snowflake.html
blob: a1caa17c721613d26e0b0d9d55d4f4d535de917b [file] [log] [blame]
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>apache_beam.io.snowflake &mdash; Apache Beam 2.38.0 documentation</title>
<script type="text/javascript" src="../../../_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
<script type="text/javascript" src="../../../_static/jquery.js"></script>
<script type="text/javascript" src="../../../_static/underscore.js"></script>
<script type="text/javascript" src="../../../_static/doctools.js"></script>
<script type="text/javascript" src="../../../_static/language_data.js"></script>
<script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<script type="text/javascript" src="../../../_static/js/theme.js"></script>
<link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="../../../genindex.html" />
<link rel="search" title="Search" href="../../../search.html" />
</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"> Apache Beam
</a>
<div class="version">
2.38.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../apache_beam.coders.html">apache_beam.coders package</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../apache_beam.dataframe.html">apache_beam.dataframe package</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../apache_beam.io.html">apache_beam.io package</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../apache_beam.metrics.html">apache_beam.metrics package</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../apache_beam.ml.html">apache_beam.ml package</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../apache_beam.options.html">apache_beam.options package</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../apache_beam.portability.html">apache_beam.portability package</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../apache_beam.runners.html">apache_beam.runners package</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../apache_beam.transforms.html">apache_beam.transforms package</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../apache_beam.typehints.html">apache_beam.typehints package</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../apache_beam.utils.html">apache_beam.utils package</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../apache_beam.error.html">apache_beam.error module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../apache_beam.pipeline.html">apache_beam.pipeline module</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../apache_beam.pvalue.html">apache_beam.pvalue module</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">Apache Beam</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../../index.html">Docs</a> &raquo;</li>
<li><a href="../../index.html">Module code</a> &raquo;</li>
<li>apache_beam.io.snowflake</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 apache_beam.io.snowflake</h1><div class="highlight"><pre>
<span></span><span class="c1">#</span>
<span class="c1"># Licensed to the Apache Software Foundation (ASF) under one or more</span>
<span class="c1"># contributor license agreements. See the NOTICE file distributed with</span>
<span class="c1"># this work for additional information regarding copyright ownership.</span>
<span class="c1"># The ASF licenses this file to You under the Apache License, Version 2.0</span>
<span class="c1"># (the &quot;License&quot;); you may not use this file except in compliance with</span>
<span class="c1"># 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, software</span>
<span class="c1"># distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span>
<span class="c1"># WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<span class="c1"># See the License for the specific language governing permissions and</span>
<span class="c1"># limitations under the License.</span>
<span class="c1">#</span>
<span class="sd">&quot;&quot;&quot;Snowflake transforms tested against Flink portable runner.</span>
<span class="sd"> **Setup**</span>
<span class="sd"> Transforms provided in this module are cross-language transforms</span>
<span class="sd"> implemented in the Beam Java SDK. During the pipeline construction, Python SDK</span>
<span class="sd"> will connect to a Java expansion service to expand these transforms.</span>
<span class="sd"> To facilitate this, a small amount of setup is needed before using these</span>
<span class="sd"> transforms in a Beam Python pipeline.</span>
<span class="sd"> There are several ways to setup cross-language Snowflake transforms.</span>
<span class="sd"> * Option 1: use the default expansion service</span>
<span class="sd"> * Option 2: specify a custom expansion service</span>
<span class="sd"> See below for details regarding each of these options.</span>
<span class="sd"> *Option 1: Use the default expansion service*</span>
<span class="sd"> This is the recommended and easiest setup option for using Python Snowflake</span>
<span class="sd"> transforms.This option requires following pre-requisites</span>
<span class="sd"> before running the Beam pipeline.</span>
<span class="sd"> * Install Java runtime in the computer from where the pipeline is constructed</span>
<span class="sd"> and make sure that &#39;java&#39; command is available.</span>
<span class="sd"> In this option, Python SDK will either download (for released Beam version) or</span>
<span class="sd"> build (when running from a Beam Git clone) a expansion service jar and use</span>
<span class="sd"> that to expand transforms. Currently Snowflake transforms use the</span>
<span class="sd"> &#39;beam-sdks-java-io-snowflake-expansion-service&#39; jar for this purpose.</span>
<span class="sd"> *Option 2: specify a custom expansion service*</span>
<span class="sd"> In this option, you startup your own expansion service and provide that as</span>
<span class="sd"> a parameter when using the transforms provided in this module.</span>
<span class="sd"> This option requires following pre-requisites before running the Beam</span>
<span class="sd"> pipeline.</span>
<span class="sd"> * Startup your own expansion service.</span>
<span class="sd"> * Update your pipeline to provide the expansion service address when</span>
<span class="sd"> initiating Snowflake transforms provided in this module.</span>
<span class="sd"> Flink Users can use the built-in Expansion Service of the Flink Runner&#39;s</span>
<span class="sd"> Job Server. If you start Flink&#39;s Job Server, the expansion service will be</span>
<span class="sd"> started on port 8097. For a different address, please set the</span>
<span class="sd"> expansion_service parameter.</span>
<span class="sd"> **More information**</span>
<span class="sd"> For more information regarding cross-language transforms see:</span>
<span class="sd"> - https://beam.apache.org/roadmap/portability/</span>
<span class="sd"> For more information specific to Flink runner see:</span>
<span class="sd"> - https://beam.apache.org/documentation/runners/flink/</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="c1"># pytype: skip-file</span>
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Iterable</span>
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">NamedTuple</span>
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Optional</span>
<span class="kn">import</span> <span class="nn">apache_beam</span> <span class="k">as</span> <span class="nn">beam</span>
<span class="kn">from</span> <span class="nn">apache_beam.transforms.external</span> <span class="kn">import</span> <span class="n">BeamJarExpansionService</span>
<span class="kn">from</span> <span class="nn">apache_beam.transforms.external</span> <span class="kn">import</span> <span class="n">ExternalTransform</span>
<span class="kn">from</span> <span class="nn">apache_beam.transforms.external</span> <span class="kn">import</span> <span class="n">NamedTupleBasedPayloadBuilder</span>
<span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span>
<span class="s1">&#39;ReadFromSnowflake&#39;</span><span class="p">,</span>
<span class="s1">&#39;WriteToSnowflake&#39;</span><span class="p">,</span>
<span class="s1">&#39;WriteDisposition&#39;</span><span class="p">,</span>
<span class="s1">&#39;CreateDisposition&#39;</span><span class="p">,</span>
<span class="p">]</span>
<span class="k">def</span> <span class="nf">default_io_expansion_service</span><span class="p">():</span>
<span class="k">return</span> <span class="n">BeamJarExpansionService</span><span class="p">(</span>
<span class="s1">&#39;sdks:java:io:snowflake:expansion-service:shadowJar&#39;</span><span class="p">)</span>
<span class="n">ReadFromSnowflakeSchema</span> <span class="o">=</span> <span class="n">NamedTuple</span><span class="p">(</span>
<span class="s1">&#39;ReadFromSnowflakeSchema&#39;</span><span class="p">,</span>
<span class="p">[</span>
<span class="p">(</span><span class="s1">&#39;server_name&#39;</span><span class="p">,</span> <span class="nb">str</span><span class="p">),</span>
<span class="p">(</span><span class="s1">&#39;schema&#39;</span><span class="p">,</span> <span class="nb">str</span><span class="p">),</span>
<span class="p">(</span><span class="s1">&#39;database&#39;</span><span class="p">,</span> <span class="nb">str</span><span class="p">),</span>
<span class="p">(</span><span class="s1">&#39;staging_bucket_name&#39;</span><span class="p">,</span> <span class="nb">str</span><span class="p">),</span>
<span class="p">(</span><span class="s1">&#39;storage_integration_name&#39;</span><span class="p">,</span> <span class="nb">str</span><span class="p">),</span>
<span class="p">(</span><span class="s1">&#39;username&#39;</span><span class="p">,</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]),</span>
<span class="p">(</span><span class="s1">&#39;password&#39;</span><span class="p">,</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]),</span>
<span class="p">(</span><span class="s1">&#39;private_key_path&#39;</span><span class="p">,</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]),</span>
<span class="p">(</span><span class="s1">&#39;raw_private_key&#39;</span><span class="p">,</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]),</span>
<span class="p">(</span><span class="s1">&#39;private_key_passphrase&#39;</span><span class="p">,</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]),</span>
<span class="p">(</span><span class="s1">&#39;o_auth_token&#39;</span><span class="p">,</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]),</span>
<span class="p">(</span><span class="s1">&#39;table&#39;</span><span class="p">,</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]),</span>
<span class="p">(</span><span class="s1">&#39;query&#39;</span><span class="p">,</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]),</span>
<span class="p">(</span><span class="s1">&#39;role&#39;</span><span class="p">,</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]),</span>
<span class="p">(</span><span class="s1">&#39;warehouse&#39;</span><span class="p">,</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]),</span>
<span class="p">])</span>
<div class="viewcode-block" id="ReadFromSnowflake"><a class="viewcode-back" href="../../../apache_beam.io.snowflake.html#apache_beam.io.snowflake.ReadFromSnowflake">[docs]</a><span class="k">class</span> <span class="nc">ReadFromSnowflake</span><span class="p">(</span><span class="n">beam</span><span class="o">.</span><span class="n">PTransform</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> An external PTransform which reads from Snowflake.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">URN</span> <span class="o">=</span> <span class="s1">&#39;beam:transform:org.apache.beam:snowflake_read:v1&#39;</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span>
<span class="n">server_name</span><span class="p">,</span>
<span class="n">schema</span><span class="p">,</span>
<span class="n">database</span><span class="p">,</span>
<span class="n">staging_bucket_name</span><span class="p">,</span>
<span class="n">storage_integration_name</span><span class="p">,</span>
<span class="n">csv_mapper</span><span class="p">,</span>
<span class="n">username</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">password</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">private_key_path</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">raw_private_key</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">private_key_passphrase</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">o_auth_token</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">table</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">query</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">role</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">warehouse</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">expansion_service</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Initializes a read operation from Snowflake.</span>
<span class="sd"> Required parameters:</span>
<span class="sd"> :param server_name: full Snowflake server name with the following format</span>
<span class="sd"> https://account.region.gcp.snowflakecomputing.com.</span>
<span class="sd"> :param schema: name of the Snowflake schema in the database to use.</span>
<span class="sd"> :param database: name of the Snowflake database to use.</span>
<span class="sd"> :param staging_bucket_name: name of the Google Cloud Storage bucket.</span>
<span class="sd"> Bucket will be used as a temporary location for storing CSV files.</span>
<span class="sd"> Those temporary directories will be named</span>
<span class="sd"> &#39;sf_copy_csv_DATE_TIME_RANDOMSUFFIX&#39;</span>
<span class="sd"> and they will be removed automatically once Read operation finishes.</span>
<span class="sd"> :param storage_integration_name: is the name of storage integration</span>
<span class="sd"> object created according to Snowflake documentation.</span>
<span class="sd"> :param csv_mapper: specifies a function which must translate</span>
<span class="sd"> user-defined object to array of strings.</span>
<span class="sd"> SnowflakeIO uses a COPY INTO &lt;location&gt; statement to move data from</span>
<span class="sd"> a Snowflake table to Google Cloud Storage as CSV files.These files</span>
<span class="sd"> are then downloaded via FileIO and processed line by line.</span>
<span class="sd"> Each line is split into an array of Strings using the OpenCSV</span>
<span class="sd"> The csv_mapper function job is to give the user the possibility to</span>
<span class="sd"> convert the array of Strings to a user-defined type,</span>
<span class="sd"> ie. GenericRecord for Avro or Parquet files, or custom objects.</span>
<span class="sd"> Example:</span>
<span class="sd"> def csv_mapper(strings_array)</span>
<span class="sd"> return User(strings_array[0], int(strings_array[1])))</span>
<span class="sd"> :param table: specifies a Snowflake table name.</span>
<span class="sd"> :param query: specifies a Snowflake custom SQL query.</span>
<span class="sd"> :param role: specifies a Snowflake role.</span>
<span class="sd"> :param warehouse: specifies a Snowflake warehouse name.</span>
<span class="sd"> :param expansion_service: specifies URL of expansion service.</span>
<span class="sd"> Authentication parameters:</span>
<span class="sd"> :param username: specifies username for</span>
<span class="sd"> username/password authentication method.</span>
<span class="sd"> :param password: specifies password for</span>
<span class="sd"> username/password authentication method.</span>
<span class="sd"> :param private_key_path: specifies a private key file for</span>
<span class="sd"> key/ pair authentication method.</span>
<span class="sd"> :param raw_private_key: specifies a private key for</span>
<span class="sd"> key/ pair authentication method.</span>
<span class="sd"> :param private_key_passphrase: specifies password for</span>
<span class="sd"> key/ pair authentication method.</span>
<span class="sd"> :param o_auth_token: specifies access token for</span>
<span class="sd"> OAuth authentication method.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">verify_credentials</span><span class="p">(</span>
<span class="n">username</span><span class="o">=</span><span class="n">username</span><span class="p">,</span>
<span class="n">password</span><span class="o">=</span><span class="n">password</span><span class="p">,</span>
<span class="n">private_key_path</span><span class="o">=</span><span class="n">private_key_path</span><span class="p">,</span>
<span class="n">raw_private_key</span><span class="o">=</span><span class="n">raw_private_key</span><span class="p">,</span>
<span class="n">o_auth_token</span><span class="o">=</span><span class="n">o_auth_token</span><span class="p">,</span>
<span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">params</span> <span class="o">=</span> <span class="n">ReadFromSnowflakeSchema</span><span class="p">(</span>
<span class="n">server_name</span><span class="o">=</span><span class="n">server_name</span><span class="p">,</span>
<span class="n">schema</span><span class="o">=</span><span class="n">schema</span><span class="p">,</span>
<span class="n">database</span><span class="o">=</span><span class="n">database</span><span class="p">,</span>
<span class="n">staging_bucket_name</span><span class="o">=</span><span class="n">staging_bucket_name</span><span class="p">,</span>
<span class="n">storage_integration_name</span><span class="o">=</span><span class="n">storage_integration_name</span><span class="p">,</span>
<span class="n">username</span><span class="o">=</span><span class="n">username</span><span class="p">,</span>
<span class="n">password</span><span class="o">=</span><span class="n">password</span><span class="p">,</span>
<span class="n">private_key_path</span><span class="o">=</span><span class="n">private_key_path</span><span class="p">,</span>
<span class="n">raw_private_key</span><span class="o">=</span><span class="n">raw_private_key</span><span class="p">,</span>
<span class="n">private_key_passphrase</span><span class="o">=</span><span class="n">private_key_passphrase</span><span class="p">,</span>
<span class="n">o_auth_token</span><span class="o">=</span><span class="n">o_auth_token</span><span class="p">,</span>
<span class="n">table</span><span class="o">=</span><span class="n">table</span><span class="p">,</span>
<span class="n">query</span><span class="o">=</span><span class="n">query</span><span class="p">,</span>
<span class="n">role</span><span class="o">=</span><span class="n">role</span><span class="p">,</span>
<span class="n">warehouse</span><span class="o">=</span><span class="n">warehouse</span><span class="p">,</span>
<span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">csv_mapper</span> <span class="o">=</span> <span class="n">csv_mapper</span>
<span class="bp">self</span><span class="o">.</span><span class="n">expansion_service</span> <span class="o">=</span> <span class="n">expansion_service</span> <span class="ow">or</span> <span class="n">default_io_expansion_service</span><span class="p">()</span>
<div class="viewcode-block" id="ReadFromSnowflake.expand"><a class="viewcode-back" href="../../../apache_beam.io.snowflake.html#apache_beam.io.snowflake.ReadFromSnowflake.expand">[docs]</a> <span class="k">def</span> <span class="nf">expand</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">pbegin</span><span class="p">):</span>
<span class="k">return</span> <span class="p">(</span>
<span class="n">pbegin</span>
<span class="o">|</span> <span class="n">ExternalTransform</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">URN</span><span class="p">,</span>
<span class="n">NamedTupleBasedPayloadBuilder</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="p">),</span>
<span class="bp">self</span><span class="o">.</span><span class="n">expansion_service</span><span class="p">,</span>
<span class="p">)</span>
<span class="o">|</span> <span class="s1">&#39;CSV to array mapper&#39;</span> <span class="o">&gt;&gt;</span> <span class="n">beam</span><span class="o">.</span><span class="n">Map</span><span class="p">(</span><span class="k">lambda</span> <span class="n">csv</span><span class="p">:</span> <span class="n">csv</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="sa">b</span><span class="s1">&#39;,&#39;</span><span class="p">))</span>
<span class="o">|</span> <span class="s1">&#39;CSV mapper&#39;</span> <span class="o">&gt;&gt;</span> <span class="n">beam</span><span class="o">.</span><span class="n">Map</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">csv_mapper</span><span class="p">))</span></div></div>
<span class="n">WriteToSnowflakeSchema</span> <span class="o">=</span> <span class="n">NamedTuple</span><span class="p">(</span>
<span class="s1">&#39;WriteToSnowflakeSchema&#39;</span><span class="p">,</span>
<span class="p">[</span>
<span class="p">(</span><span class="s1">&#39;server_name&#39;</span><span class="p">,</span> <span class="nb">str</span><span class="p">),</span>
<span class="p">(</span><span class="s1">&#39;schema&#39;</span><span class="p">,</span> <span class="nb">str</span><span class="p">),</span>
<span class="p">(</span><span class="s1">&#39;database&#39;</span><span class="p">,</span> <span class="nb">str</span><span class="p">),</span>
<span class="p">(</span><span class="s1">&#39;staging_bucket_name&#39;</span><span class="p">,</span> <span class="nb">str</span><span class="p">),</span>
<span class="p">(</span><span class="s1">&#39;storage_integration_name&#39;</span><span class="p">,</span> <span class="nb">str</span><span class="p">),</span>
<span class="p">(</span><span class="s1">&#39;create_disposition&#39;</span><span class="p">,</span> <span class="nb">str</span><span class="p">),</span>
<span class="p">(</span><span class="s1">&#39;write_disposition&#39;</span><span class="p">,</span> <span class="nb">str</span><span class="p">),</span>
<span class="p">(</span><span class="s1">&#39;table_schema&#39;</span><span class="p">,</span> <span class="nb">str</span><span class="p">),</span>
<span class="p">(</span><span class="s1">&#39;username&#39;</span><span class="p">,</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]),</span>
<span class="p">(</span><span class="s1">&#39;password&#39;</span><span class="p">,</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]),</span>
<span class="p">(</span><span class="s1">&#39;private_key_path&#39;</span><span class="p">,</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]),</span>
<span class="p">(</span><span class="s1">&#39;raw_private_key&#39;</span><span class="p">,</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]),</span>
<span class="p">(</span><span class="s1">&#39;private_key_passphrase&#39;</span><span class="p">,</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]),</span>
<span class="p">(</span><span class="s1">&#39;o_auth_token&#39;</span><span class="p">,</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]),</span>
<span class="p">(</span><span class="s1">&#39;table&#39;</span><span class="p">,</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]),</span>
<span class="p">(</span><span class="s1">&#39;query&#39;</span><span class="p">,</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]),</span>
<span class="p">(</span><span class="s1">&#39;role&#39;</span><span class="p">,</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]),</span>
<span class="p">(</span><span class="s1">&#39;warehouse&#39;</span><span class="p">,</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]),</span>
<span class="p">],</span>
<span class="p">)</span>
<div class="viewcode-block" id="WriteToSnowflake"><a class="viewcode-back" href="../../../apache_beam.io.snowflake.html#apache_beam.io.snowflake.WriteToSnowflake">[docs]</a><span class="k">class</span> <span class="nc">WriteToSnowflake</span><span class="p">(</span><span class="n">beam</span><span class="o">.</span><span class="n">PTransform</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> An external PTransform which writes to Snowflake.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">URN</span> <span class="o">=</span> <span class="s1">&#39;beam:transform:org.apache.beam:snowflake_write:v1&#39;</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span>
<span class="n">server_name</span><span class="p">,</span>
<span class="n">schema</span><span class="p">,</span>
<span class="n">database</span><span class="p">,</span>
<span class="n">staging_bucket_name</span><span class="p">,</span>
<span class="n">storage_integration_name</span><span class="p">,</span>
<span class="n">create_disposition</span><span class="p">,</span>
<span class="n">write_disposition</span><span class="p">,</span>
<span class="n">table_schema</span><span class="p">,</span>
<span class="n">user_data_mapper</span><span class="p">,</span>
<span class="n">username</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">password</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">private_key_path</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">raw_private_key</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">private_key_passphrase</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">o_auth_token</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">table</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">query</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">role</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">warehouse</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">expansion_service</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="p">):</span>
<span class="c1"># pylint: disable=line-too-long</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Initializes a write operation to Snowflake.</span>
<span class="sd"> Required parameters:</span>
<span class="sd"> :param server_name: full Snowflake server name with the following format</span>
<span class="sd"> https://account.region.gcp.snowflakecomputing.com.</span>
<span class="sd"> :param schema: name of the Snowflake schema in the database to use.</span>
<span class="sd"> :param database: name of the Snowflake database to use.</span>
<span class="sd"> :param staging_bucket_name: name of the Google Cloud Storage bucket.</span>
<span class="sd"> Bucket will be used as a temporary location for storing CSV files.</span>
<span class="sd"> :param storage_integration_name: is the name of a Snowflake storage</span>
<span class="sd"> integration object created according to Snowflake documentation for the</span>
<span class="sd"> GCS bucket.</span>
<span class="sd"> :param user_data_mapper: specifies a function which maps data from</span>
<span class="sd"> a PCollection to an array of String values before the write operation</span>
<span class="sd"> saves the data to temporary .csv files.</span>
<span class="sd"> Example:</span>
<span class="sd"> def user_data_mapper(user):</span>
<span class="sd"> return [user.name, str(user.age)]</span>
<span class="sd"> :param table: specifies a Snowflake table name</span>
<span class="sd"> :param query: specifies a custom SQL query</span>
<span class="sd"> :param role: specifies a Snowflake role.</span>
<span class="sd"> :param warehouse: specifies a Snowflake warehouse name.</span>
<span class="sd"> :param expansion_service: specifies URL of expansion service.</span>
<span class="sd"> Authentication parameters:</span>
<span class="sd"> :param username: specifies username for</span>
<span class="sd"> username/password authentication method.</span>
<span class="sd"> :param password: specifies password for</span>
<span class="sd"> username/password authentication method.</span>
<span class="sd"> :param private_key_path: specifies a private key file for</span>
<span class="sd"> key/ pair authentication method.</span>
<span class="sd"> :param raw_private_key: specifies a private key for</span>
<span class="sd"> key/ pair authentication method.</span>
<span class="sd"> :param private_key_passphrase: specifies password for</span>
<span class="sd"> key/ pair authentication method.</span>
<span class="sd"> :param o_auth_token: specifies access token for</span>
<span class="sd"> OAuth authentication method.</span>
<span class="sd"> Additional parameters:</span>
<span class="sd"> :param create_disposition: Defines the behaviour of the write operation if</span>
<span class="sd"> the target table does not exist. The following values are supported:</span>
<span class="sd"> CREATE_IF_NEEDED - default behaviour. The write operation checks whether</span>
<span class="sd"> the specified target table exists; if it does not, the write operation</span>
<span class="sd"> attempts to create the table Specify the schema for the target table</span>
<span class="sd"> using the table_schema parameter.</span>
<span class="sd"> CREATE_NEVER - The write operation fails if the target table does not</span>
<span class="sd"> exist.</span>
<span class="sd"> :param write_disposition: Defines the write behaviour based on the table</span>
<span class="sd"> where data will be written to. The following values are supported:</span>
<span class="sd"> APPEND - Default behaviour. Written data is added to the existing rows</span>
<span class="sd"> in the table,</span>
<span class="sd"> EMPTY - The target table must be empty; otherwise, the write operation</span>
<span class="sd"> fails,</span>
<span class="sd"> TRUNCATE - The write operation deletes all rows from the target table</span>
<span class="sd"> before writing to it.</span>
<span class="sd"> :param table_schema: When the create_disposition parameter is set to</span>
<span class="sd"> CREATE_IF_NEEDED, the table_schema parameter enables specifying the</span>
<span class="sd"> schema for the created target table. A table schema is as JSON with the</span>
<span class="sd"> following structure:</span>
<span class="sd"> .. code-block:: none</span>
<span class="sd"> {&quot;schema&quot;:[</span>
<span class="sd"> {</span>
<span class="sd"> &quot;dataType&quot;:{&quot;type&quot;:&quot;&lt;COLUMN DATA TYPE&gt;&quot;},</span>
<span class="sd"> &quot;name&quot;:&quot;&lt;COLUMN NAME&gt;&quot;,</span>
<span class="sd"> &quot;nullable&quot;: &lt;NULLABLE&gt;</span>
<span class="sd"> },</span>
<span class="sd"> ]}</span>
<span class="sd"> All supported data types:</span>
<span class="sd"> .. code-block:: json</span>
<span class="sd"> {&quot;schema&quot;:[</span>
<span class="sd"> {&quot;dataType&quot;:{&quot;type&quot;:&quot;date&quot;},&quot;name&quot;:&quot;&quot;,&quot;nullable&quot;:false},</span>
<span class="sd"> {&quot;dataType&quot;:{&quot;type&quot;:&quot;datetime&quot;},&quot;name&quot;:&quot;&quot;,&quot;nullable&quot;:false},</span>
<span class="sd"> {&quot;dataType&quot;:{&quot;type&quot;:&quot;time&quot;},&quot;name&quot;:&quot;&quot;,&quot;nullable&quot;:false},</span>
<span class="sd"> {&quot;dataType&quot;:{&quot;type&quot;:&quot;timestamp&quot;},&quot;name&quot;:&quot;&quot;,&quot;nullable&quot;:false},</span>
<span class="sd"> {&quot;dataType&quot;:{&quot;type&quot;:&quot;timestamp_ltz&quot;},&quot;name&quot;:&quot;&quot;,&quot;nullable&quot;:false},</span>
<span class="sd"> {&quot;dataType&quot;:{&quot;type&quot;:&quot;timestamp_ntz&quot;},&quot;name&quot;:&quot;&quot;,&quot;nullable&quot;:false},</span>
<span class="sd"> {&quot;dataType&quot;:{&quot;type&quot;:&quot;timestamp_tz&quot;},&quot;name&quot;:&quot;&quot;,&quot;nullable&quot;:false},</span>
<span class="sd"> {&quot;dataType&quot;:{&quot;type&quot;:&quot;boolean&quot;},&quot;name&quot;:&quot;&quot;,&quot;nullable&quot;:false},</span>
<span class="sd"> {&quot;dataType&quot;:{&quot;type&quot;:&quot;decimal&quot;,&quot;precision&quot;:38,&quot;scale&quot;:1},&quot;name&quot;:&quot;&quot;,&quot;nullable&quot;:true},</span>
<span class="sd"> {&quot;dataType&quot;:{&quot;type&quot;:&quot;double&quot;},&quot;name&quot;:&quot;&quot;,&quot;nullable&quot;:false},</span>
<span class="sd"> {&quot;dataType&quot;:{&quot;type&quot;:&quot;float&quot;},&quot;name&quot;:&quot;&quot;,&quot;nullable&quot;:false},</span>
<span class="sd"> {&quot;dataType&quot;:{&quot;type&quot;:&quot;integer&quot;,&quot;precision&quot;:38,&quot;scale&quot;:0},&quot;name&quot;:&quot;&quot;,&quot;nullable&quot;:false},</span>
<span class="sd"> {&quot;dataType&quot;:{&quot;type&quot;:&quot;number&quot;,&quot;precision&quot;:38,&quot;scale&quot;:1},&quot;name&quot;:&quot;&quot;,&quot;nullable&quot;:false},</span>
<span class="sd"> {&quot;dataType&quot;:{&quot;type&quot;:&quot;numeric&quot;,&quot;precision&quot;:38,&quot;scale&quot;:2},&quot;name&quot;:&quot;&quot;,&quot;nullable&quot;:false},</span>
<span class="sd"> {&quot;dataType&quot;:{&quot;type&quot;:&quot;real&quot;},&quot;name&quot;:&quot;&quot;,&quot;nullable&quot;:false},</span>
<span class="sd"> {&quot;dataType&quot;:{&quot;type&quot;:&quot;array&quot;},&quot;name&quot;:&quot;&quot;,&quot;nullable&quot;:false},</span>
<span class="sd"> {&quot;dataType&quot;:{&quot;type&quot;:&quot;object&quot;},&quot;name&quot;:&quot;&quot;,&quot;nullable&quot;:false},</span>
<span class="sd"> {&quot;dataType&quot;:{&quot;type&quot;:&quot;variant&quot;},&quot;name&quot;:&quot;&quot;,&quot;nullable&quot;:true},</span>
<span class="sd"> {&quot;dataType&quot;:{&quot;type&quot;:&quot;binary&quot;,&quot;size&quot;:null},&quot;name&quot;:&quot;&quot;,&quot;nullable&quot;:false},</span>
<span class="sd"> {&quot;dataType&quot;:{&quot;type&quot;:&quot;char&quot;,&quot;length&quot;:1},&quot;name&quot;:&quot;&quot;,&quot;nullable&quot;:false},</span>
<span class="sd"> {&quot;dataType&quot;:{&quot;type&quot;:&quot;string&quot;,&quot;length&quot;:null},&quot;name&quot;:&quot;&quot;,&quot;nullable&quot;:false},</span>
<span class="sd"> {&quot;dataType&quot;:{&quot;type&quot;:&quot;text&quot;,&quot;length&quot;:null},&quot;name&quot;:&quot;&quot;,&quot;nullable&quot;:false},</span>
<span class="sd"> {&quot;dataType&quot;:{&quot;type&quot;:&quot;varbinary&quot;,&quot;size&quot;:null},&quot;name&quot;:&quot;&quot;,&quot;nullable&quot;:false},</span>
<span class="sd"> {&quot;dataType&quot;:{&quot;type&quot;:&quot;varchar&quot;,&quot;length&quot;:100},&quot;name&quot;:&quot;&quot;,&quot;nullable&quot;:false},</span>
<span class="sd"> {&quot;dataType&quot;:{&quot;type&quot;:&quot;geography&quot;},&quot;name&quot;:&quot;&quot;,&quot;nullable&quot;:true}]</span>
<span class="sd"> }</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">verify_credentials</span><span class="p">(</span>
<span class="n">username</span><span class="o">=</span><span class="n">username</span><span class="p">,</span>
<span class="n">password</span><span class="o">=</span><span class="n">password</span><span class="p">,</span>
<span class="n">private_key_path</span><span class="o">=</span><span class="n">private_key_path</span><span class="p">,</span>
<span class="n">raw_private_key</span><span class="o">=</span><span class="n">raw_private_key</span><span class="p">,</span>
<span class="n">o_auth_token</span><span class="o">=</span><span class="n">o_auth_token</span><span class="p">,</span>
<span class="p">)</span>
<span class="n">WriteDisposition</span><span class="o">.</span><span class="n">VerifyParam</span><span class="p">(</span><span class="n">write_disposition</span><span class="p">)</span>
<span class="n">CreateDisposition</span><span class="o">.</span><span class="n">VerifyParam</span><span class="p">(</span><span class="n">create_disposition</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">params</span> <span class="o">=</span> <span class="n">WriteToSnowflakeSchema</span><span class="p">(</span>
<span class="n">server_name</span><span class="o">=</span><span class="n">server_name</span><span class="p">,</span>
<span class="n">schema</span><span class="o">=</span><span class="n">schema</span><span class="p">,</span>
<span class="n">database</span><span class="o">=</span><span class="n">database</span><span class="p">,</span>
<span class="n">staging_bucket_name</span><span class="o">=</span><span class="n">staging_bucket_name</span><span class="p">,</span>
<span class="n">storage_integration_name</span><span class="o">=</span><span class="n">storage_integration_name</span><span class="p">,</span>
<span class="n">create_disposition</span><span class="o">=</span><span class="n">create_disposition</span><span class="p">,</span>
<span class="n">write_disposition</span><span class="o">=</span><span class="n">write_disposition</span><span class="p">,</span>
<span class="n">table_schema</span><span class="o">=</span><span class="n">table_schema</span><span class="p">,</span>
<span class="n">username</span><span class="o">=</span><span class="n">username</span><span class="p">,</span>
<span class="n">password</span><span class="o">=</span><span class="n">password</span><span class="p">,</span>
<span class="n">private_key_path</span><span class="o">=</span><span class="n">private_key_path</span><span class="p">,</span>
<span class="n">raw_private_key</span><span class="o">=</span><span class="n">raw_private_key</span><span class="p">,</span>
<span class="n">private_key_passphrase</span><span class="o">=</span><span class="n">private_key_passphrase</span><span class="p">,</span>
<span class="n">o_auth_token</span><span class="o">=</span><span class="n">o_auth_token</span><span class="p">,</span>
<span class="n">table</span><span class="o">=</span><span class="n">table</span><span class="p">,</span>
<span class="n">query</span><span class="o">=</span><span class="n">query</span><span class="p">,</span>
<span class="n">role</span><span class="o">=</span><span class="n">role</span><span class="p">,</span>
<span class="n">warehouse</span><span class="o">=</span><span class="n">warehouse</span><span class="p">,</span>
<span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">user_data_mapper</span> <span class="o">=</span> <span class="n">user_data_mapper</span>
<span class="bp">self</span><span class="o">.</span><span class="n">expansion_service</span> <span class="o">=</span> <span class="n">expansion_service</span> <span class="ow">or</span> <span class="n">default_io_expansion_service</span><span class="p">()</span>
<div class="viewcode-block" id="WriteToSnowflake.expand"><a class="viewcode-back" href="../../../apache_beam.io.snowflake.html#apache_beam.io.snowflake.WriteToSnowflake.expand">[docs]</a> <span class="k">def</span> <span class="nf">expand</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">pbegin</span><span class="p">):</span>
<span class="k">return</span> <span class="p">(</span>
<span class="n">pbegin</span>
<span class="o">|</span> <span class="s1">&#39;User data mapper&#39;</span> <span class="o">&gt;&gt;</span> <span class="n">beam</span><span class="o">.</span><span class="n">Map</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">user_data_mapper</span><span class="p">)</span><span class="o">.</span><span class="n">with_output_types</span><span class="p">(</span><span class="n">Iterable</span><span class="p">[</span><span class="nb">bytes</span><span class="p">])</span>
<span class="o">|</span> <span class="n">ExternalTransform</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">URN</span><span class="p">,</span>
<span class="n">NamedTupleBasedPayloadBuilder</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="p">),</span>
<span class="bp">self</span><span class="o">.</span><span class="n">expansion_service</span><span class="p">))</span></div></div>
<div class="viewcode-block" id="CreateDisposition"><a class="viewcode-back" href="../../../apache_beam.io.snowflake.html#apache_beam.io.snowflake.CreateDisposition">[docs]</a><span class="k">class</span> <span class="nc">CreateDisposition</span><span class="p">:</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Enum class for possible values of create dispositions:</span>
<span class="sd"> CREATE_IF_NEEDED: default behaviour. The write operation checks whether</span>
<span class="sd"> the specified target table exists; if it does not, the write operation</span>
<span class="sd"> attempts to create the table Specify the schema for the target table</span>
<span class="sd"> using the table_schema parameter.</span>
<span class="sd"> CREATE_NEVER: The write operation fails if the target table does not exist.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">CREATE_IF_NEEDED</span> <span class="o">=</span> <span class="s1">&#39;CREATE_IF_NEEDED&#39;</span>
<span class="n">CREATE_NEVER</span> <span class="o">=</span> <span class="s1">&#39;CREATE_NEVER&#39;</span>
<div class="viewcode-block" id="CreateDisposition.VerifyParam"><a class="viewcode-back" href="../../../apache_beam.io.snowflake.html#apache_beam.io.snowflake.CreateDisposition.VerifyParam">[docs]</a> <span class="nd">@staticmethod</span>
<span class="k">def</span> <span class="nf">VerifyParam</span><span class="p">(</span><span class="n">field</span><span class="p">):</span>
<span class="k">if</span> <span class="n">field</span> <span class="ow">and</span> <span class="ow">not</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">CreateDisposition</span><span class="p">,</span> <span class="n">field</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span>
<span class="s1">&#39;Create disposition has to be one of the following values:&#39;</span>
<span class="s1">&#39;CREATE_IF_NEEDED, CREATE_NEVER. Got: </span><span class="si">{}</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">field</span><span class="p">))</span></div></div>
<div class="viewcode-block" id="WriteDisposition"><a class="viewcode-back" href="../../../apache_beam.io.snowflake.html#apache_beam.io.snowflake.WriteDisposition">[docs]</a><span class="k">class</span> <span class="nc">WriteDisposition</span><span class="p">:</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Enum class for possible values of write dispositions:</span>
<span class="sd"> APPEND: Default behaviour. Written data is added to the existing rows</span>
<span class="sd"> in the table,</span>
<span class="sd"> EMPTY: The target table must be empty; otherwise, the write operation fails,</span>
<span class="sd"> TRUNCATE: The write operation deletes all rows from the target table</span>
<span class="sd"> before writing to it.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">APPEND</span> <span class="o">=</span> <span class="s1">&#39;APPEND&#39;</span>
<span class="n">EMPTY</span> <span class="o">=</span> <span class="s1">&#39;EMPTY&#39;</span>
<span class="n">TRUNCATE</span> <span class="o">=</span> <span class="s1">&#39;TRUNCATE&#39;</span>
<div class="viewcode-block" id="WriteDisposition.VerifyParam"><a class="viewcode-back" href="../../../apache_beam.io.snowflake.html#apache_beam.io.snowflake.WriteDisposition.VerifyParam">[docs]</a> <span class="nd">@staticmethod</span>
<span class="k">def</span> <span class="nf">VerifyParam</span><span class="p">(</span><span class="n">field</span><span class="p">):</span>
<span class="k">if</span> <span class="n">field</span> <span class="ow">and</span> <span class="ow">not</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">WriteDisposition</span><span class="p">,</span> <span class="n">field</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span>
<span class="s1">&#39;Write disposition has to be one of the following values:&#39;</span>
<span class="s1">&#39;APPEND, EMPTY, TRUNCATE. Got: </span><span class="si">{}</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">field</span><span class="p">))</span></div></div>
<span class="k">def</span> <span class="nf">verify_credentials</span><span class="p">(</span>
<span class="n">username</span><span class="p">,</span> <span class="n">password</span><span class="p">,</span> <span class="n">private_key_path</span><span class="p">,</span> <span class="n">raw_private_key</span><span class="p">,</span> <span class="n">o_auth_token</span><span class="p">):</span>
<span class="k">if</span> <span class="ow">not</span> <span class="p">(</span><span class="n">o_auth_token</span> <span class="ow">or</span> <span class="p">(</span><span class="n">username</span> <span class="ow">and</span> <span class="n">password</span><span class="p">)</span> <span class="ow">or</span>
<span class="p">(</span><span class="n">username</span> <span class="ow">and</span> <span class="p">(</span><span class="n">private_key_path</span> <span class="ow">or</span> <span class="n">raw_private_key</span><span class="p">))):</span>
<span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="s1">&#39;Snowflake credentials are not set correctly.&#39;</span><span class="p">)</span>
</pre></div>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>