blob: e0b272f20bb2c9dec67a0a20fd80e85d5ecb5b31 [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 module &mdash; Apache Beam 2.37.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" />
<link rel="next" title="apache_beam.io.source_test_utils module" href="apache_beam.io.source_test_utils.html" />
<link rel="prev" title="apache_beam.io.restriction_trackers module" href="apache_beam.io.restriction_trackers.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.37.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 class="current">
<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 current"><a class="reference internal" href="apache_beam.io.html">apache_beam.io package</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="apache_beam.io.html#subpackages">Subpackages</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="apache_beam.io.html#submodules">Submodules</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.avroio.html">apache_beam.io.avroio module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.concat_source.html">apache_beam.io.concat_source module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.debezium.html">apache_beam.io.debezium module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.filebasedsink.html">apache_beam.io.filebasedsink module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.filebasedsource.html">apache_beam.io.filebasedsource module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.fileio.html">apache_beam.io.fileio module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.filesystem.html">apache_beam.io.filesystem module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.filesystemio.html">apache_beam.io.filesystemio module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.filesystems.html">apache_beam.io.filesystems module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.hadoopfilesystem.html">apache_beam.io.hadoopfilesystem module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.iobase.html">apache_beam.io.iobase module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.jdbc.html">apache_beam.io.jdbc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.kafka.html">apache_beam.io.kafka module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.kinesis.html">apache_beam.io.kinesis module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.localfilesystem.html">apache_beam.io.localfilesystem module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.mongodbio.html">apache_beam.io.mongodbio module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.parquetio.html">apache_beam.io.parquetio module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.range_trackers.html">apache_beam.io.range_trackers module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.restriction_trackers.html">apache_beam.io.restriction_trackers module</a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="#">apache_beam.io.snowflake module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.source_test_utils.html">apache_beam.io.source_test_utils module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.textio.html">apache_beam.io.textio module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.tfrecordio.html">apache_beam.io.tfrecordio module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.utils.html">apache_beam.io.utils module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.watermark_estimators.html">apache_beam.io.watermark_estimators module</a></li>
</ul>
</li>
</ul>
</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="apache_beam.io.html">apache_beam.io package</a> &raquo;</li>
<li>apache_beam.io.snowflake module</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/apache_beam.io.snowflake.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="module-apache_beam.io.snowflake">
<span id="apache-beam-io-snowflake-module"></span><h1>apache_beam.io.snowflake module<a class="headerlink" href="#module-apache_beam.io.snowflake" title="Permalink to this headline"></a></h1>
<p>Snowflake transforms tested against Flink portable runner.</p>
<p><strong>Setup</strong></p>
<p>Transforms provided in this module are cross-language transforms
implemented in the Beam Java SDK. During the pipeline construction, Python SDK
will connect to a Java expansion service to expand these transforms.
To facilitate this, a small amount of setup is needed before using these
transforms in a Beam Python pipeline.</p>
<p>There are several ways to setup cross-language Snowflake transforms.</p>
<ul class="simple">
<li>Option 1: use the default expansion service</li>
<li>Option 2: specify a custom expansion service</li>
</ul>
<p>See below for details regarding each of these options.</p>
<p><em>Option 1: Use the default expansion service</em></p>
<p>This is the recommended and easiest setup option for using Python Snowflake
transforms.This option requires following pre-requisites
before running the Beam pipeline.</p>
<ul class="simple">
<li>Install Java runtime in the computer from where the pipeline is constructed
and make sure that ‘java’ command is available.</li>
</ul>
<p>In this option, Python SDK will either download (for released Beam version) or
build (when running from a Beam Git clone) a expansion service jar and use
that to expand transforms. Currently Snowflake transforms use the
‘beam-sdks-java-io-snowflake-expansion-service’ jar for this purpose.</p>
<p><em>Option 2: specify a custom expansion service</em></p>
<p>In this option, you startup your own expansion service and provide that as
a parameter when using the transforms provided in this module.</p>
<p>This option requires following pre-requisites before running the Beam
pipeline.</p>
<ul class="simple">
<li>Startup your own expansion service.</li>
<li>Update your pipeline to provide the expansion service address when
initiating Snowflake transforms provided in this module.</li>
</ul>
<p>Flink Users can use the built-in Expansion Service of the Flink Runner’s
Job Server. If you start Flink’s Job Server, the expansion service will be
started on port 8097. For a different address, please set the
expansion_service parameter.</p>
<p><strong>More information</strong></p>
<p>For more information regarding cross-language transforms see:
- <a class="reference external" href="https://beam.apache.org/roadmap/portability/">https://beam.apache.org/roadmap/portability/</a></p>
<p>For more information specific to Flink runner see:
- <a class="reference external" href="https://beam.apache.org/documentation/runners/flink/">https://beam.apache.org/documentation/runners/flink/</a></p>
<dl class="class">
<dt id="apache_beam.io.snowflake.ReadFromSnowflake">
<em class="property">class </em><code class="descclassname">apache_beam.io.snowflake.</code><code class="descname">ReadFromSnowflake</code><span class="sig-paren">(</span><em>server_name</em>, <em>schema</em>, <em>database</em>, <em>staging_bucket_name</em>, <em>storage_integration_name</em>, <em>csv_mapper</em>, <em>username=None</em>, <em>password=None</em>, <em>private_key_path=None</em>, <em>raw_private_key=None</em>, <em>private_key_passphrase=None</em>, <em>o_auth_token=None</em>, <em>table=None</em>, <em>query=None</em>, <em>role=None</em>, <em>warehouse=None</em>, <em>expansion_service=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/snowflake.html#ReadFromSnowflake"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.snowflake.ReadFromSnowflake" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="apache_beam.transforms.ptransform.html#apache_beam.transforms.ptransform.PTransform" title="apache_beam.transforms.ptransform.PTransform"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.transforms.ptransform.PTransform</span></code></a></p>
<p>An external PTransform which reads from Snowflake.</p>
<p>Initializes a read operation from Snowflake.</p>
<p>Required parameters:</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>server_name</strong> – full Snowflake server name with the following format
<a class="reference external" href="https://account.region.gcp.snowflakecomputing.com">https://account.region.gcp.snowflakecomputing.com</a>.</li>
<li><strong>schema</strong> – name of the Snowflake schema in the database to use.</li>
<li><strong>database</strong> – name of the Snowflake database to use.</li>
<li><strong>staging_bucket_name</strong> – name of the Google Cloud Storage bucket.
Bucket will be used as a temporary location for storing CSV files.
Those temporary directories will be named
‘sf_copy_csv_DATE_TIME_RANDOMSUFFIX’
and they will be removed automatically once Read operation finishes.</li>
<li><strong>storage_integration_name</strong> – is the name of storage integration
object created according to Snowflake documentation.</li>
<li><strong>csv_mapper</strong> – specifies a function which must translate
user-defined object to array of strings.
SnowflakeIO uses a COPY INTO &lt;location&gt; statement to move data from
a Snowflake table to Google Cloud Storage as CSV files.These files
are then downloaded via FileIO and processed line by line.
Each line is split into an array of Strings using the OpenCSV
The csv_mapper function job is to give the user the possibility to
convert the array of Strings to a user-defined type,
ie. GenericRecord for Avro or Parquet files, or custom objects.
Example:
def csv_mapper(strings_array)
return User(strings_array[0], int(strings_array[1])))</li>
<li><strong>table</strong> – specifies a Snowflake table name.</li>
<li><strong>query</strong> – specifies a Snowflake custom SQL query.</li>
<li><strong>role</strong> – specifies a Snowflake role.</li>
<li><strong>warehouse</strong> – specifies a Snowflake warehouse name.</li>
<li><strong>expansion_service</strong> – specifies URL of expansion service.</li>
</ul>
</td>
</tr>
</tbody>
</table>
<p>Authentication parameters:</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>username</strong> – specifies username for
username/password authentication method.</li>
<li><strong>password</strong> – specifies password for
username/password authentication method.</li>
<li><strong>private_key_path</strong> – specifies a private key file for
key/ pair authentication method.</li>
<li><strong>raw_private_key</strong> – specifies a private key for
key/ pair authentication method.</li>
<li><strong>private_key_passphrase</strong> – specifies password for
key/ pair authentication method.</li>
<li><strong>o_auth_token</strong> – specifies access token for
OAuth authentication method.</li>
</ul>
</td>
</tr>
</tbody>
</table>
<dl class="attribute">
<dt id="apache_beam.io.snowflake.ReadFromSnowflake.URN">
<code class="descname">URN</code><em class="property"> = 'beam:transform:org.apache.beam:snowflake_read:v1'</em><a class="headerlink" href="#apache_beam.io.snowflake.ReadFromSnowflake.URN" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="apache_beam.io.snowflake.ReadFromSnowflake.expand">
<code class="descname">expand</code><span class="sig-paren">(</span><em>pbegin</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/snowflake.html#ReadFromSnowflake.expand"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.snowflake.ReadFromSnowflake.expand" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="apache_beam.io.snowflake.WriteToSnowflake">
<em class="property">class </em><code class="descclassname">apache_beam.io.snowflake.</code><code class="descname">WriteToSnowflake</code><span class="sig-paren">(</span><em>server_name</em>, <em>schema</em>, <em>database</em>, <em>staging_bucket_name</em>, <em>storage_integration_name</em>, <em>create_disposition</em>, <em>write_disposition</em>, <em>table_schema</em>, <em>user_data_mapper</em>, <em>username=None</em>, <em>password=None</em>, <em>private_key_path=None</em>, <em>raw_private_key=None</em>, <em>private_key_passphrase=None</em>, <em>o_auth_token=None</em>, <em>table=None</em>, <em>query=None</em>, <em>role=None</em>, <em>warehouse=None</em>, <em>expansion_service=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/snowflake.html#WriteToSnowflake"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.snowflake.WriteToSnowflake" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="apache_beam.transforms.ptransform.html#apache_beam.transforms.ptransform.PTransform" title="apache_beam.transforms.ptransform.PTransform"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.transforms.ptransform.PTransform</span></code></a></p>
<p>An external PTransform which writes to Snowflake.</p>
<p>Initializes a write operation to Snowflake.</p>
<p>Required parameters:</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>server_name</strong> – full Snowflake server name with the following format
<a class="reference external" href="https://account.region.gcp.snowflakecomputing.com">https://account.region.gcp.snowflakecomputing.com</a>.</li>
<li><strong>schema</strong> – name of the Snowflake schema in the database to use.</li>
<li><strong>database</strong> – name of the Snowflake database to use.</li>
<li><strong>staging_bucket_name</strong> – name of the Google Cloud Storage bucket.
Bucket will be used as a temporary location for storing CSV files.</li>
<li><strong>storage_integration_name</strong> – is the name of a Snowflake storage
integration object created according to Snowflake documentation for the
GCS bucket.</li>
<li><strong>user_data_mapper</strong> – specifies a function which maps data from
a PCollection to an array of String values before the write operation
saves the data to temporary .csv files.
Example:
def user_data_mapper(user):
return [user.name, str(user.age)]</li>
<li><strong>table</strong> – specifies a Snowflake table name</li>
<li><strong>query</strong> – specifies a custom SQL query</li>
<li><strong>role</strong> – specifies a Snowflake role.</li>
<li><strong>warehouse</strong> – specifies a Snowflake warehouse name.</li>
<li><strong>expansion_service</strong> – specifies URL of expansion service.</li>
</ul>
</td>
</tr>
</tbody>
</table>
<p>Authentication parameters:</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>username</strong> – specifies username for
username/password authentication method.</li>
<li><strong>password</strong> – specifies password for
username/password authentication method.</li>
<li><strong>private_key_path</strong> – specifies a private key file for
key/ pair authentication method.</li>
<li><strong>raw_private_key</strong> – specifies a private key for
key/ pair authentication method.</li>
<li><strong>private_key_passphrase</strong> – specifies password for
key/ pair authentication method.</li>
<li><strong>o_auth_token</strong> – specifies access token for
OAuth authentication method.</li>
</ul>
</td>
</tr>
</tbody>
</table>
<p>Additional parameters:</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>create_disposition</strong> – Defines the behaviour of the write operation if
the target table does not exist. The following values are supported:
CREATE_IF_NEEDED - default behaviour. The write operation checks whether
the specified target table exists; if it does not, the write operation
attempts to create the table Specify the schema for the target table
using the table_schema parameter.
CREATE_NEVER - The write operation fails if the target table does not
exist.</li>
<li><strong>write_disposition</strong> – Defines the write behaviour based on the table
where data will be written to. The following values are supported:
APPEND - Default behaviour. Written data is added to the existing rows
in the table,
EMPTY - The target table must be empty; otherwise, the write operation
fails,
TRUNCATE - The write operation deletes all rows from the target table
before writing to it.</li>
<li><strong>table_schema</strong><p>When the create_disposition parameter is set to
CREATE_IF_NEEDED, the table_schema parameter enables specifying the
schema for the created target table. A table schema is as JSON with the
following structure:
{“schema”:[
{
“dataType”:{“type”:”&lt;COLUMN DATA TYPE&gt;”},
“name”:”&lt;COLUMN NAME&gt; “,
“nullable”: &lt;NULLABLE&gt;
},
]}</p>
<p>All supported data types:
{“schema”:[
{“dataType”:{“type”:”date”},”name”:””,”nullable”:false},
{“dataType”:{“type”:”datetime”},”name”:””,”nullable”:false},
{“dataType”:{“type”:”time”},”name”:””,”nullable”:false},
{“dataType”:{“type”:”timestamp”},”name”:””,”nullable”:false},
{“dataType”:{“type”:”timestamp_ltz”},”name”:””,”nullable”:false},
{“dataType”:{“type”:”timestamp_ntz”},”name”:””,”nullable”:false},
{“dataType”:{“type”:”timestamp_tz”},”name”:””,”nullable”:false},
{“dataType”:{“type”:”boolean”},”name”:””,”nullable”:false},
{“dataType”:{“type”:”decimal”,”precision”:38,”scale”:1},”name”:””,”nullable”:true},
{“dataType”:{“type”:”double”},”name”:””,”nullable”:false},
{“dataType”:{“type”:”float”},”name”:””,”nullable”:false},
{“dataType”:{“type”:”integer”,”precision”:38,”scale”:0},”name”:””,”nullable”:false},
{“dataType”:{“type”:”number”,”precision”:38,”scale”:1},”name”:””,”nullable”:false},
{“dataType”:{“type”:”numeric”,”precision”:38,”scale”:2},”name”:””,”nullable”:false},
{“dataType”:{“type”:”real”},”name”:””,”nullable”:false},
{“dataType”:{“type”:”array”},”name”:””,”nullable”:false},
{“dataType”:{“type”:”object”},”name”:””,”nullable”:false},
{“dataType”:{“type”:”variant”},”name”:””,”nullable”:true},
{“dataType”:{“type”:”binary”,”size”:null},”name”:””,”nullable”:false},
{“dataType”:{“type”:”char”,”length”:1},”name”:””,”nullable”:false},
{“dataType”:{“type”:”string”,”length”:null},”name”:””,”nullable”:false},
{“dataType”:{“type”:”text”,”length”:null},”name”:””,”nullable”:false},
{“dataType”:{“type”:”varbinary”,”size”:null},”name”:””,”nullable”:false},
{“dataType”:{“type”:”varchar”,”length”:100},”name”:””,”nullable”:false}]
}</p>
</li>
</ul>
</td>
</tr>
</tbody>
</table>
<dl class="attribute">
<dt id="apache_beam.io.snowflake.WriteToSnowflake.URN">
<code class="descname">URN</code><em class="property"> = 'beam:transform:org.apache.beam:snowflake_write:v1'</em><a class="headerlink" href="#apache_beam.io.snowflake.WriteToSnowflake.URN" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="apache_beam.io.snowflake.WriteToSnowflake.expand">
<code class="descname">expand</code><span class="sig-paren">(</span><em>pbegin</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/snowflake.html#WriteToSnowflake.expand"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.snowflake.WriteToSnowflake.expand" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="apache_beam.io.snowflake.CreateDisposition">
<em class="property">class </em><code class="descclassname">apache_beam.io.snowflake.</code><code class="descname">CreateDisposition</code><a class="reference internal" href="_modules/apache_beam/io/snowflake.html#CreateDisposition"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.snowflake.CreateDisposition" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>Enum class for possible values of create dispositions:
CREATE_IF_NEEDED: default behaviour. The write operation checks whether
the specified target table exists; if it does not, the write operation
attempts to create the table Specify the schema for the target table
using the table_schema parameter.
CREATE_NEVER: The write operation fails if the target table does not exist.</p>
<dl class="attribute">
<dt id="apache_beam.io.snowflake.CreateDisposition.CREATE_IF_NEEDED">
<code class="descname">CREATE_IF_NEEDED</code><em class="property"> = 'CREATE_IF_NEEDED'</em><a class="headerlink" href="#apache_beam.io.snowflake.CreateDisposition.CREATE_IF_NEEDED" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="apache_beam.io.snowflake.CreateDisposition.CREATE_NEVER">
<code class="descname">CREATE_NEVER</code><em class="property"> = 'CREATE_NEVER'</em><a class="headerlink" href="#apache_beam.io.snowflake.CreateDisposition.CREATE_NEVER" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="staticmethod">
<dt id="apache_beam.io.snowflake.CreateDisposition.VerifyParam">
<em class="property">static </em><code class="descname">VerifyParam</code><span class="sig-paren">(</span><em>field</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/snowflake.html#CreateDisposition.VerifyParam"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.snowflake.CreateDisposition.VerifyParam" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="apache_beam.io.snowflake.WriteDisposition">
<em class="property">class </em><code class="descclassname">apache_beam.io.snowflake.</code><code class="descname">WriteDisposition</code><a class="reference internal" href="_modules/apache_beam/io/snowflake.html#WriteDisposition"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.snowflake.WriteDisposition" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>Enum class for possible values of write dispositions:
APPEND: Default behaviour. Written data is added to the existing rows
in the table,
EMPTY: The target table must be empty; otherwise, the write operation fails,
TRUNCATE: The write operation deletes all rows from the target table
before writing to it.</p>
<dl class="attribute">
<dt id="apache_beam.io.snowflake.WriteDisposition.APPEND">
<code class="descname">APPEND</code><em class="property"> = 'APPEND'</em><a class="headerlink" href="#apache_beam.io.snowflake.WriteDisposition.APPEND" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="apache_beam.io.snowflake.WriteDisposition.EMPTY">
<code class="descname">EMPTY</code><em class="property"> = 'EMPTY'</em><a class="headerlink" href="#apache_beam.io.snowflake.WriteDisposition.EMPTY" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="apache_beam.io.snowflake.WriteDisposition.TRUNCATE">
<code class="descname">TRUNCATE</code><em class="property"> = 'TRUNCATE'</em><a class="headerlink" href="#apache_beam.io.snowflake.WriteDisposition.TRUNCATE" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="staticmethod">
<dt id="apache_beam.io.snowflake.WriteDisposition.VerifyParam">
<em class="property">static </em><code class="descname">VerifyParam</code><span class="sig-paren">(</span><em>field</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/snowflake.html#WriteDisposition.VerifyParam"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.snowflake.WriteDisposition.VerifyParam" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="apache_beam.io.source_test_utils.html" class="btn btn-neutral float-right" title="apache_beam.io.source_test_utils module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="apache_beam.io.restriction_trackers.html" class="btn btn-neutral float-left" title="apache_beam.io.restriction_trackers module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<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>