| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>SnowflakeIO.Write (Apache Beam 2.38.0-SNAPSHOT)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="SnowflakeIO.Write (Apache Beam 2.38.0-SNAPSHOT)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.UserDataMapper.html" title="interface in org.apache.beam.sdk.io.snowflake"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakePipelineOptions.html" title="interface in org.apache.beam.sdk.io.snowflake"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" target="_top">Frames</a></li> |
| <li><a href="SnowflakeIO.Write.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#fields.inherited.from.class.org.apache.beam.sdk.transforms.PTransform">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.beam.sdk.io.snowflake</div> |
| <h2 title="Class SnowflakeIO.Write" class="title">Class SnowflakeIO.Write<T></h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">org.apache.beam.sdk.transforms.PTransform</a><<a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><T>,<a href="../../../../../../org/apache/beam/sdk/values/PDone.html" title="class in org.apache.beam.sdk.values">PDone</a>></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.beam.sdk.io.snowflake.SnowflakeIO.Write<T></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd>java.io.Serializable, <a href="../../../../../../org/apache/beam/sdk/transforms/display/HasDisplayData.html" title="interface in org.apache.beam.sdk.transforms.display">HasDisplayData</a></dd> |
| </dl> |
| <dl> |
| <dt>Enclosing class:</dt> |
| <dd><a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.html" title="class in org.apache.beam.sdk.io.snowflake">SnowflakeIO</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public abstract static class <span class="typeNameLabel">SnowflakeIO.Write<T></span> |
| extends <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a><<a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><T>,<a href="../../../../../../org/apache/beam/sdk/values/PDone.html" title="class in org.apache.beam.sdk.values">PDone</a>></pre> |
| <div class="block">Implementation of <a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.html#write--"><code>SnowflakeIO.write()</code></a>.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../serialized-form.html#org.apache.beam.sdk.io.snowflake.SnowflakeIO.Write">Serialized Form</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.beam.sdk.transforms.PTransform"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.beam.sdk.transforms.<a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a></h3> |
| <code><a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#name">name</a>, <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#resourceHints">resourceHints</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html#Write--">Write</a></span>()</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/values/PDone.html" title="class in org.apache.beam.sdk.values">PDone</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html#expand-org.apache.beam.sdk.values.PCollection-">expand</a></span>(<a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><<a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="type parameter in SnowflakeIO.Write">T</a>> input)</code> |
| <div class="block">Override this method to specify how this <code>PTransform</code> should be expanded on the given |
| <code>InputT</code>.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html#streamToTable-org.apache.beam.sdk.io.snowflake.services.SnowflakeService-org.apache.beam.sdk.options.ValueProvider-">streamToTable</a></span>(<a href="../../../../../../org/apache/beam/sdk/io/snowflake/services/SnowflakeService.html" title="interface in org.apache.beam.sdk.io.snowflake.services">SnowflakeService</a> snowflakeService, |
| <a href="../../../../../../org/apache/beam/sdk/options/ValueProvider.html" title="interface in org.apache.beam.sdk.options">ValueProvider</a><java.lang.String> stagingBucketDir)</code> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="class in org.apache.beam.sdk.io.snowflake">SnowflakeIO.Write</a><<a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="type parameter in SnowflakeIO.Write">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html#to-java.lang.String-">to</a></span>(java.lang.String table)</code> |
| <div class="block">A table name to be written in Snowflake.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="class in org.apache.beam.sdk.io.snowflake">SnowflakeIO.Write</a><<a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="type parameter in SnowflakeIO.Write">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html#to-org.apache.beam.sdk.options.ValueProvider-">to</a></span>(<a href="../../../../../../org/apache/beam/sdk/options/ValueProvider.html" title="interface in org.apache.beam.sdk.options">ValueProvider</a><java.lang.String> table)</code> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="class in org.apache.beam.sdk.io.snowflake">SnowflakeIO.Write</a><<a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="type parameter in SnowflakeIO.Write">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html#withCreateDisposition-org.apache.beam.sdk.io.snowflake.enums.CreateDisposition-">withCreateDisposition</a></span>(<a href="../../../../../../org/apache/beam/sdk/io/snowflake/enums/CreateDisposition.html" title="enum in org.apache.beam.sdk.io.snowflake.enums">CreateDisposition</a> createDisposition)</code> |
| <div class="block">A disposition to be used during table preparation.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="class in org.apache.beam.sdk.io.snowflake">SnowflakeIO.Write</a><<a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="type parameter in SnowflakeIO.Write">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html#withDataSourceConfiguration-org.apache.beam.sdk.io.snowflake.SnowflakeIO.DataSourceConfiguration-">withDataSourceConfiguration</a></span>(<a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.DataSourceConfiguration.html" title="class in org.apache.beam.sdk.io.snowflake">SnowflakeIO.DataSourceConfiguration</a> config)</code> |
| <div class="block">Setting information about Snowflake server.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="class in org.apache.beam.sdk.io.snowflake">SnowflakeIO.Write</a><<a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="type parameter in SnowflakeIO.Write">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html#withDataSourceProviderFn-org.apache.beam.sdk.transforms.SerializableFunction-">withDataSourceProviderFn</a></span>(<a href="../../../../../../org/apache/beam/sdk/transforms/SerializableFunction.html" title="interface in org.apache.beam.sdk.transforms">SerializableFunction</a><java.lang.Void,javax.sql.DataSource> dataSourceProviderFn)</code> |
| <div class="block">Setting function that will provide <a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.DataSourceConfiguration.html" title="class in org.apache.beam.sdk.io.snowflake"><code>SnowflakeIO.DataSourceConfiguration</code></a> in runtime.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="class in org.apache.beam.sdk.io.snowflake">SnowflakeIO.Write</a><<a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="type parameter in SnowflakeIO.Write">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html#withDebugMode-org.apache.beam.sdk.io.snowflake.enums.StreamingLogLevel-">withDebugMode</a></span>(<a href="../../../../../../org/apache/beam/sdk/io/snowflake/enums/StreamingLogLevel.html" title="enum in org.apache.beam.sdk.io.snowflake.enums">StreamingLogLevel</a> debugLevel)</code> |
| <div class="block">The option to verbose info (or only errors) of loaded files while streaming.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="class in org.apache.beam.sdk.io.snowflake">SnowflakeIO.Write</a><<a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="type parameter in SnowflakeIO.Write">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html#withFileNameTemplate-java.lang.String-">withFileNameTemplate</a></span>(java.lang.String fileNameTemplate)</code> |
| <div class="block">A template name for files saved to GCP.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="class in org.apache.beam.sdk.io.snowflake">SnowflakeIO.Write</a><<a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="type parameter in SnowflakeIO.Write">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html#withFlushRowLimit-java.lang.Integer-">withFlushRowLimit</a></span>(java.lang.Integer rowsCount)</code> |
| <div class="block">Sets number of row limit that will be saved to the staged file and then loaded to Snowflake.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="class in org.apache.beam.sdk.io.snowflake">SnowflakeIO.Write</a><<a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="type parameter in SnowflakeIO.Write">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html#withFlushTimeLimit-org.joda.time.Duration-">withFlushTimeLimit</a></span>(<a href="https://static.javadoc.io/joda-time/joda-time/2.10.10/org/joda/time/Duration.html?is-external=true" title="class or interface in org.joda.time">Duration</a> triggeringFrequency)</code> |
| <div class="block">Sets duration how often staged files will be created and then how often ingested by Snowflake |
| during streaming.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="class in org.apache.beam.sdk.io.snowflake">SnowflakeIO.Write</a><<a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="type parameter in SnowflakeIO.Write">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html#withQueryTransformation-java.lang.String-">withQueryTransformation</a></span>(java.lang.String query)</code> |
| <div class="block">A query to be executed in Snowflake.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="class in org.apache.beam.sdk.io.snowflake">SnowflakeIO.Write</a><<a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="type parameter in SnowflakeIO.Write">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html#withQueryTransformation-org.apache.beam.sdk.options.ValueProvider-">withQueryTransformation</a></span>(<a href="../../../../../../org/apache/beam/sdk/options/ValueProvider.html" title="interface in org.apache.beam.sdk.options">ValueProvider</a><java.lang.String> query)</code> </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="class in org.apache.beam.sdk.io.snowflake">SnowflakeIO.Write</a><<a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="type parameter in SnowflakeIO.Write">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html#withQuotationMark-java.lang.String-">withQuotationMark</a></span>(java.lang.String quotationMark)</code> |
| <div class="block">Sets Snowflake-specific quotations around strings.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="class in org.apache.beam.sdk.io.snowflake">SnowflakeIO.Write</a><<a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="type parameter in SnowflakeIO.Write">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html#withShardsNumber-java.lang.Integer-">withShardsNumber</a></span>(java.lang.Integer shardsNumber)</code> |
| <div class="block">Number of shards that are created per window.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="class in org.apache.beam.sdk.io.snowflake">SnowflakeIO.Write</a><<a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="type parameter in SnowflakeIO.Write">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html#withSnowflakeService-org.apache.beam.sdk.io.snowflake.services.SnowflakeService-">withSnowflakeService</a></span>(<a href="../../../../../../org/apache/beam/sdk/io/snowflake/services/SnowflakeService.html" title="interface in org.apache.beam.sdk.io.snowflake.services">SnowflakeService</a> snowflakeService)</code> |
| <div class="block">A snowflake service <a href="../../../../../../org/apache/beam/sdk/io/snowflake/services/SnowflakeService.html" title="interface in org.apache.beam.sdk.io.snowflake.services"><code>SnowflakeService</code></a> implementation which is supposed to be used.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="class in org.apache.beam.sdk.io.snowflake">SnowflakeIO.Write</a><<a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="type parameter in SnowflakeIO.Write">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html#withSnowPipe-java.lang.String-">withSnowPipe</a></span>(java.lang.String snowPipe)</code> |
| <div class="block">Sets name of <a |
| href="https://docs.snowflake.com/en/user-guide/data-load-snowpipe-intro.html">SnowPipe</a> |
| which can be created in Snowflake dashboard or cli:</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="class in org.apache.beam.sdk.io.snowflake">SnowflakeIO.Write</a><<a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="type parameter in SnowflakeIO.Write">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html#withSnowPipe-org.apache.beam.sdk.options.ValueProvider-">withSnowPipe</a></span>(<a href="../../../../../../org/apache/beam/sdk/options/ValueProvider.html" title="interface in org.apache.beam.sdk.options">ValueProvider</a><java.lang.String> snowPipe)</code> |
| <div class="block">Same as <code>withSnowPipe(String</code>, but with a <a href="../../../../../../org/apache/beam/sdk/options/ValueProvider.html" title="interface in org.apache.beam.sdk.options"><code>ValueProvider</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="class in org.apache.beam.sdk.io.snowflake">SnowflakeIO.Write</a><<a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="type parameter in SnowflakeIO.Write">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html#withStagingBucketName-java.lang.String-">withStagingBucketName</a></span>(java.lang.String stagingBucketName)</code> |
| <div class="block">Name of the cloud bucket (GCS by now) to use as tmp location of CSVs during COPY statement.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="class in org.apache.beam.sdk.io.snowflake">SnowflakeIO.Write</a><<a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="type parameter in SnowflakeIO.Write">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html#withStagingBucketName-org.apache.beam.sdk.options.ValueProvider-">withStagingBucketName</a></span>(<a href="../../../../../../org/apache/beam/sdk/options/ValueProvider.html" title="interface in org.apache.beam.sdk.options">ValueProvider</a><java.lang.String> stagingBucketName)</code> </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="class in org.apache.beam.sdk.io.snowflake">SnowflakeIO.Write</a><<a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="type parameter in SnowflakeIO.Write">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html#withStorageIntegrationName-java.lang.String-">withStorageIntegrationName</a></span>(java.lang.String integrationName)</code> |
| <div class="block">Name of the Storage Integration in Snowflake to be used.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="class in org.apache.beam.sdk.io.snowflake">SnowflakeIO.Write</a><<a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="type parameter in SnowflakeIO.Write">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html#withStorageIntegrationName-org.apache.beam.sdk.options.ValueProvider-">withStorageIntegrationName</a></span>(<a href="../../../../../../org/apache/beam/sdk/options/ValueProvider.html" title="interface in org.apache.beam.sdk.options">ValueProvider</a><java.lang.String> integrationName)</code> </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="class in org.apache.beam.sdk.io.snowflake">SnowflakeIO.Write</a><<a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="type parameter in SnowflakeIO.Write">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html#withTableSchema-org.apache.beam.sdk.io.snowflake.data.SnowflakeTableSchema-">withTableSchema</a></span>(<a href="../../../../../../org/apache/beam/sdk/io/snowflake/data/SnowflakeTableSchema.html" title="class in org.apache.beam.sdk.io.snowflake.data">SnowflakeTableSchema</a> tableSchema)</code> |
| <div class="block">Table schema to be used during creating table.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="class in org.apache.beam.sdk.io.snowflake">SnowflakeIO.Write</a><<a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="type parameter in SnowflakeIO.Write">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html#withUserDataMapper-org.apache.beam.sdk.io.snowflake.SnowflakeIO.UserDataMapper-">withUserDataMapper</a></span>(<a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.UserDataMapper.html" title="interface in org.apache.beam.sdk.io.snowflake">SnowflakeIO.UserDataMapper</a> userDataMapper)</code> |
| <div class="block">User-defined function mapping user data into CSV lines.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="class in org.apache.beam.sdk.io.snowflake">SnowflakeIO.Write</a><<a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="type parameter in SnowflakeIO.Write">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html#withWriteDisposition-org.apache.beam.sdk.io.snowflake.enums.WriteDisposition-">withWriteDisposition</a></span>(<a href="../../../../../../org/apache/beam/sdk/io/snowflake/enums/WriteDisposition.html" title="enum in org.apache.beam.sdk.io.snowflake.enums">WriteDisposition</a> writeDisposition)</code> |
| <div class="block">A disposition to be used during writing to table phase.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.beam.sdk.transforms.PTransform"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.beam.sdk.transforms.<a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a></h3> |
| <code><a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#compose-org.apache.beam.sdk.transforms.SerializableFunction-">compose</a>, <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#compose-java.lang.String-org.apache.beam.sdk.transforms.SerializableFunction-">compose</a>, <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#getAdditionalInputs--">getAdditionalInputs</a>, <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#getDefaultOutputCoder--">getDefaultOutputCoder</a>, <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#getDefaultOutputCoder-InputT-">getDefaultOutputCoder</a>, <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#getDefaultOutputCoder-InputT-org.apache.beam.sdk.values.PCollection-">getDefaultOutputCoder</a>, <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#getKindString--">getKindString</a>, <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#getName--">getName</a>, <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#getResourceHints--">getResourceHints</a>, <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#populateDisplayData-org.apache.beam.sdk.transforms.display.DisplayData.Builder-">populateDisplayData</a>, <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#setResourceHints-org.apache.beam.sdk.transforms.resourcehints.ResourceHints-">setResourceHints</a>, <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#toString--">toString</a>, <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#validate-org.apache.beam.sdk.options.PipelineOptions-">validate</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="Write--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>Write</h4> |
| <pre>public Write()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="withDataSourceConfiguration-org.apache.beam.sdk.io.snowflake.SnowflakeIO.DataSourceConfiguration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withDataSourceConfiguration</h4> |
| <pre>public <a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="class in org.apache.beam.sdk.io.snowflake">SnowflakeIO.Write</a><<a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="type parameter in SnowflakeIO.Write">T</a>> withDataSourceConfiguration(<a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.DataSourceConfiguration.html" title="class in org.apache.beam.sdk.io.snowflake">SnowflakeIO.DataSourceConfiguration</a> config)</pre> |
| <div class="block">Setting information about Snowflake server.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>config</code> - An instance of <a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.DataSourceConfiguration.html" title="class in org.apache.beam.sdk.io.snowflake"><code>SnowflakeIO.DataSourceConfiguration</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withDataSourceProviderFn-org.apache.beam.sdk.transforms.SerializableFunction-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withDataSourceProviderFn</h4> |
| <pre>public <a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="class in org.apache.beam.sdk.io.snowflake">SnowflakeIO.Write</a><<a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="type parameter in SnowflakeIO.Write">T</a>> withDataSourceProviderFn(<a href="../../../../../../org/apache/beam/sdk/transforms/SerializableFunction.html" title="interface in org.apache.beam.sdk.transforms">SerializableFunction</a><java.lang.Void,javax.sql.DataSource> dataSourceProviderFn)</pre> |
| <div class="block">Setting function that will provide <a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.DataSourceConfiguration.html" title="class in org.apache.beam.sdk.io.snowflake"><code>SnowflakeIO.DataSourceConfiguration</code></a> in runtime.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>dataSourceProviderFn</code> - a <a href="../../../../../../org/apache/beam/sdk/transforms/SerializableFunction.html" title="interface in org.apache.beam.sdk.transforms"><code>SerializableFunction</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="to-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>to</h4> |
| <pre>public <a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="class in org.apache.beam.sdk.io.snowflake">SnowflakeIO.Write</a><<a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="type parameter in SnowflakeIO.Write">T</a>> to(java.lang.String table)</pre> |
| <div class="block">A table name to be written in Snowflake.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>table</code> - String with the name of the table.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="to-org.apache.beam.sdk.options.ValueProvider-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>to</h4> |
| <pre>public <a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="class in org.apache.beam.sdk.io.snowflake">SnowflakeIO.Write</a><<a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="type parameter in SnowflakeIO.Write">T</a>> to(<a href="../../../../../../org/apache/beam/sdk/options/ValueProvider.html" title="interface in org.apache.beam.sdk.options">ValueProvider</a><java.lang.String> table)</pre> |
| </li> |
| </ul> |
| <a name="withStagingBucketName-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withStagingBucketName</h4> |
| <pre>public <a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="class in org.apache.beam.sdk.io.snowflake">SnowflakeIO.Write</a><<a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="type parameter in SnowflakeIO.Write">T</a>> withStagingBucketName(java.lang.String stagingBucketName)</pre> |
| <div class="block">Name of the cloud bucket (GCS by now) to use as tmp location of CSVs during COPY statement.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>stagingBucketName</code> - String with the name of the bucket.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withStagingBucketName-org.apache.beam.sdk.options.ValueProvider-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withStagingBucketName</h4> |
| <pre>public <a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="class in org.apache.beam.sdk.io.snowflake">SnowflakeIO.Write</a><<a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="type parameter in SnowflakeIO.Write">T</a>> withStagingBucketName(<a href="../../../../../../org/apache/beam/sdk/options/ValueProvider.html" title="interface in org.apache.beam.sdk.options">ValueProvider</a><java.lang.String> stagingBucketName)</pre> |
| </li> |
| </ul> |
| <a name="withStorageIntegrationName-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withStorageIntegrationName</h4> |
| <pre>public <a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="class in org.apache.beam.sdk.io.snowflake">SnowflakeIO.Write</a><<a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="type parameter in SnowflakeIO.Write">T</a>> withStorageIntegrationName(java.lang.String integrationName)</pre> |
| <div class="block">Name of the Storage Integration in Snowflake to be used. See |
| https://docs.snowflake.com/en/sql-reference/sql/create-storage-integration.html for |
| reference.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>integrationName</code> - String with the name of the Storage Integration.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withStorageIntegrationName-org.apache.beam.sdk.options.ValueProvider-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withStorageIntegrationName</h4> |
| <pre>public <a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="class in org.apache.beam.sdk.io.snowflake">SnowflakeIO.Write</a><<a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="type parameter in SnowflakeIO.Write">T</a>> withStorageIntegrationName(<a href="../../../../../../org/apache/beam/sdk/options/ValueProvider.html" title="interface in org.apache.beam.sdk.options">ValueProvider</a><java.lang.String> integrationName)</pre> |
| </li> |
| </ul> |
| <a name="withQueryTransformation-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withQueryTransformation</h4> |
| <pre>public <a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="class in org.apache.beam.sdk.io.snowflake">SnowflakeIO.Write</a><<a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="type parameter in SnowflakeIO.Write">T</a>> withQueryTransformation(java.lang.String query)</pre> |
| <div class="block">A query to be executed in Snowflake.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>query</code> - String with query.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withQueryTransformation-org.apache.beam.sdk.options.ValueProvider-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withQueryTransformation</h4> |
| <pre>public <a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="class in org.apache.beam.sdk.io.snowflake">SnowflakeIO.Write</a><<a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="type parameter in SnowflakeIO.Write">T</a>> withQueryTransformation(<a href="../../../../../../org/apache/beam/sdk/options/ValueProvider.html" title="interface in org.apache.beam.sdk.options">ValueProvider</a><java.lang.String> query)</pre> |
| </li> |
| </ul> |
| <a name="withFileNameTemplate-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withFileNameTemplate</h4> |
| <pre>public <a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="class in org.apache.beam.sdk.io.snowflake">SnowflakeIO.Write</a><<a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="type parameter in SnowflakeIO.Write">T</a>> withFileNameTemplate(java.lang.String fileNameTemplate)</pre> |
| <div class="block">A template name for files saved to GCP.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fileNameTemplate</code> - String with template name for files.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withUserDataMapper-org.apache.beam.sdk.io.snowflake.SnowflakeIO.UserDataMapper-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withUserDataMapper</h4> |
| <pre>public <a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="class in org.apache.beam.sdk.io.snowflake">SnowflakeIO.Write</a><<a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="type parameter in SnowflakeIO.Write">T</a>> withUserDataMapper(<a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.UserDataMapper.html" title="interface in org.apache.beam.sdk.io.snowflake">SnowflakeIO.UserDataMapper</a> userDataMapper)</pre> |
| <div class="block">User-defined function mapping user data into CSV lines.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>userDataMapper</code> - an instance of <a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.UserDataMapper.html" title="interface in org.apache.beam.sdk.io.snowflake"><code>SnowflakeIO.UserDataMapper</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withFlushTimeLimit-org.joda.time.Duration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withFlushTimeLimit</h4> |
| <pre>public <a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="class in org.apache.beam.sdk.io.snowflake">SnowflakeIO.Write</a><<a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="type parameter in SnowflakeIO.Write">T</a>> withFlushTimeLimit(<a href="https://static.javadoc.io/joda-time/joda-time/2.10.10/org/joda/time/Duration.html?is-external=true" title="class or interface in org.joda.time">Duration</a> triggeringFrequency)</pre> |
| <div class="block">Sets duration how often staged files will be created and then how often ingested by Snowflake |
| during streaming.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>triggeringFrequency</code> - time for triggering frequency in <a href="https://static.javadoc.io/joda-time/joda-time/2.10.10/org/joda/time/Duration.html?is-external=true" title="class or interface in org.joda.time"><code>Duration</code></a> type.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| </dl> |
| </li> |
| </ul> |
| <a name="withSnowPipe-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withSnowPipe</h4> |
| <pre>public <a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="class in org.apache.beam.sdk.io.snowflake">SnowflakeIO.Write</a><<a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="type parameter in SnowflakeIO.Write">T</a>> withSnowPipe(java.lang.String snowPipe)</pre> |
| <div class="block">Sets name of <a |
| href="https://docs.snowflake.com/en/user-guide/data-load-snowpipe-intro.html">SnowPipe</a> |
| which can be created in Snowflake dashboard or cli: |
| |
| <pre><code> |
| CREATE snowPipeName AS COPY INTO your_table from @yourstage; |
| </code></pre> |
| |
| <p>The stage in <a |
| href="https://docs.snowflake.com/en/sql-reference/sql/copy-into-table.html">COPY</a> |
| statement should be pointing to the cloud <a |
| href="https://docs.snowflake.com/en/sql-reference/sql/create-storage-integration.html">integration</a> |
| with the valid bucket url, ex. for GCS: |
| |
| <pre><code> |
| CREATE STAGE yourstage |
| URL = 'gcs://yourbucket/path/' |
| STORAGE_INTEGRATION = your_integration; |
| </code></pre> |
| |
| <pre><code> |
| CREATE STORAGE INTEGRATION your_integration |
| TYPE = EXTERNAL_STAGE |
| STORAGE_PROVIDER = GCS |
| ENABLED = TRUE |
| STORAGE_ALLOWED_LOCATIONS = ('gcs://yourbucket/path/') |
| </code></pre></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>snowPipe</code> - name of created SnowPipe in Snowflake dashboard.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| </dl> |
| </li> |
| </ul> |
| <a name="withSnowPipe-org.apache.beam.sdk.options.ValueProvider-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withSnowPipe</h4> |
| <pre>public <a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="class in org.apache.beam.sdk.io.snowflake">SnowflakeIO.Write</a><<a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="type parameter in SnowflakeIO.Write">T</a>> withSnowPipe(<a href="../../../../../../org/apache/beam/sdk/options/ValueProvider.html" title="interface in org.apache.beam.sdk.options">ValueProvider</a><java.lang.String> snowPipe)</pre> |
| <div class="block">Same as <code>withSnowPipe(String</code>, but with a <a href="../../../../../../org/apache/beam/sdk/options/ValueProvider.html" title="interface in org.apache.beam.sdk.options"><code>ValueProvider</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>snowPipe</code> - name of created SnowPipe in Snowflake dashboard.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| </dl> |
| </li> |
| </ul> |
| <a name="withShardsNumber-java.lang.Integer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withShardsNumber</h4> |
| <pre>public <a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="class in org.apache.beam.sdk.io.snowflake">SnowflakeIO.Write</a><<a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="type parameter in SnowflakeIO.Write">T</a>> withShardsNumber(java.lang.Integer shardsNumber)</pre> |
| <div class="block">Number of shards that are created per window.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>shardsNumber</code> - defined number of shards or 1 by default.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| </dl> |
| </li> |
| </ul> |
| <a name="withFlushRowLimit-java.lang.Integer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withFlushRowLimit</h4> |
| <pre>public <a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="class in org.apache.beam.sdk.io.snowflake">SnowflakeIO.Write</a><<a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="type parameter in SnowflakeIO.Write">T</a>> withFlushRowLimit(java.lang.Integer rowsCount)</pre> |
| <div class="block">Sets number of row limit that will be saved to the staged file and then loaded to Snowflake. |
| If the number of rows will be lower than the limit it will be loaded with current number of |
| rows after certain time specified by setting <code>withFlushTimeLimit(Duration |
| triggeringFrequency)</code></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>rowsCount</code> - Number of rows that will be in one file staged for loading. Default: 10000.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| </dl> |
| </li> |
| </ul> |
| <a name="withWriteDisposition-org.apache.beam.sdk.io.snowflake.enums.WriteDisposition-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withWriteDisposition</h4> |
| <pre>public <a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="class in org.apache.beam.sdk.io.snowflake">SnowflakeIO.Write</a><<a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="type parameter in SnowflakeIO.Write">T</a>> withWriteDisposition(<a href="../../../../../../org/apache/beam/sdk/io/snowflake/enums/WriteDisposition.html" title="enum in org.apache.beam.sdk.io.snowflake.enums">WriteDisposition</a> writeDisposition)</pre> |
| <div class="block">A disposition to be used during writing to table phase.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>writeDisposition</code> - an instance of <a href="../../../../../../org/apache/beam/sdk/io/snowflake/enums/WriteDisposition.html" title="enum in org.apache.beam.sdk.io.snowflake.enums"><code>WriteDisposition</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withCreateDisposition-org.apache.beam.sdk.io.snowflake.enums.CreateDisposition-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withCreateDisposition</h4> |
| <pre>public <a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="class in org.apache.beam.sdk.io.snowflake">SnowflakeIO.Write</a><<a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="type parameter in SnowflakeIO.Write">T</a>> withCreateDisposition(<a href="../../../../../../org/apache/beam/sdk/io/snowflake/enums/CreateDisposition.html" title="enum in org.apache.beam.sdk.io.snowflake.enums">CreateDisposition</a> createDisposition)</pre> |
| <div class="block">A disposition to be used during table preparation.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>createDisposition</code> - - an instance of <a href="../../../../../../org/apache/beam/sdk/io/snowflake/enums/CreateDisposition.html" title="enum in org.apache.beam.sdk.io.snowflake.enums"><code>CreateDisposition</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withTableSchema-org.apache.beam.sdk.io.snowflake.data.SnowflakeTableSchema-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withTableSchema</h4> |
| <pre>public <a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="class in org.apache.beam.sdk.io.snowflake">SnowflakeIO.Write</a><<a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="type parameter in SnowflakeIO.Write">T</a>> withTableSchema(<a href="../../../../../../org/apache/beam/sdk/io/snowflake/data/SnowflakeTableSchema.html" title="class in org.apache.beam.sdk.io.snowflake.data">SnowflakeTableSchema</a> tableSchema)</pre> |
| <div class="block">Table schema to be used during creating table.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>tableSchema</code> - - an instance of <a href="../../../../../../org/apache/beam/sdk/io/snowflake/data/SnowflakeTableSchema.html" title="class in org.apache.beam.sdk.io.snowflake.data"><code>SnowflakeTableSchema</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withSnowflakeService-org.apache.beam.sdk.io.snowflake.services.SnowflakeService-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withSnowflakeService</h4> |
| <pre>public <a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="class in org.apache.beam.sdk.io.snowflake">SnowflakeIO.Write</a><<a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="type parameter in SnowflakeIO.Write">T</a>> withSnowflakeService(<a href="../../../../../../org/apache/beam/sdk/io/snowflake/services/SnowflakeService.html" title="interface in org.apache.beam.sdk.io.snowflake.services">SnowflakeService</a> snowflakeService)</pre> |
| <div class="block">A snowflake service <a href="../../../../../../org/apache/beam/sdk/io/snowflake/services/SnowflakeService.html" title="interface in org.apache.beam.sdk.io.snowflake.services"><code>SnowflakeService</code></a> implementation which is supposed to be used.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>snowflakeService</code> - an instance of <a href="../../../../../../org/apache/beam/sdk/io/snowflake/services/SnowflakeService.html" title="interface in org.apache.beam.sdk.io.snowflake.services"><code>SnowflakeService</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withQuotationMark-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withQuotationMark</h4> |
| <pre>public <a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="class in org.apache.beam.sdk.io.snowflake">SnowflakeIO.Write</a><<a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="type parameter in SnowflakeIO.Write">T</a>> withQuotationMark(java.lang.String quotationMark)</pre> |
| <div class="block">Sets Snowflake-specific quotations around strings.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>quotationMark</code> - with possible single quote <code>'</code>, double quote <code>"</code> or nothing. |
| Default value is single quotation <code>'</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| </dl> |
| </li> |
| </ul> |
| <a name="withDebugMode-org.apache.beam.sdk.io.snowflake.enums.StreamingLogLevel-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withDebugMode</h4> |
| <pre>public <a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="class in org.apache.beam.sdk.io.snowflake">SnowflakeIO.Write</a><<a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="type parameter in SnowflakeIO.Write">T</a>> withDebugMode(<a href="../../../../../../org/apache/beam/sdk/io/snowflake/enums/StreamingLogLevel.html" title="enum in org.apache.beam.sdk.io.snowflake.enums">StreamingLogLevel</a> debugLevel)</pre> |
| <div class="block">The option to verbose info (or only errors) of loaded files while streaming. It is not set by |
| default because it may influence performance. For details: <a |
| href="https://docs.snowflake.com/en/user-guide/data-load-snowpipe-rest-apis.html#endpoint-insertreport">insert |
| report REST API.</a></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>debugLevel</code> - error or info debug level from enum <a href="../../../../../../org/apache/beam/sdk/io/snowflake/enums/StreamingLogLevel.html" title="enum in org.apache.beam.sdk.io.snowflake.enums"><code>StreamingLogLevel</code></a></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| </dl> |
| </li> |
| </ul> |
| <a name="expand-org.apache.beam.sdk.values.PCollection-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>expand</h4> |
| <pre>public <a href="../../../../../../org/apache/beam/sdk/values/PDone.html" title="class in org.apache.beam.sdk.values">PDone</a> expand(<a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><<a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="type parameter in SnowflakeIO.Write">T</a>> input)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#expand-InputT-">PTransform</a></code></span></div> |
| <div class="block">Override this method to specify how this <code>PTransform</code> should be expanded on the given |
| <code>InputT</code>. |
| |
| <p>NOTE: This method should not be called directly. Instead apply the <code>PTransform</code> should |
| be applied to the <code>InputT</code> using the <code>apply</code> method. |
| |
| <p>Composite transforms, which are defined in terms of other transforms, should return the |
| output of one of the composed transforms. Non-composite transforms, which do not apply any |
| transforms internally, should return a new unbound output and register evaluators (via |
| backend-specific registration methods).</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html#expand-InputT-">expand</a></code> in class <code><a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a><<a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a><<a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" title="type parameter in SnowflakeIO.Write">T</a>>,<a href="../../../../../../org/apache/beam/sdk/values/PDone.html" title="class in org.apache.beam.sdk.values">PDone</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="streamToTable-org.apache.beam.sdk.io.snowflake.services.SnowflakeService-org.apache.beam.sdk.options.ValueProvider-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>streamToTable</h4> |
| <pre>protected <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a> streamToTable(<a href="../../../../../../org/apache/beam/sdk/io/snowflake/services/SnowflakeService.html" title="interface in org.apache.beam.sdk.io.snowflake.services">SnowflakeService</a> snowflakeService, |
| <a href="../../../../../../org/apache/beam/sdk/options/ValueProvider.html" title="interface in org.apache.beam.sdk.options">ValueProvider</a><java.lang.String> stagingBucketDir)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakeIO.UserDataMapper.html" title="interface in org.apache.beam.sdk.io.snowflake"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/beam/sdk/io/snowflake/SnowflakePipelineOptions.html" title="interface in org.apache.beam.sdk.io.snowflake"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/beam/sdk/io/snowflake/SnowflakeIO.Write.html" target="_top">Frames</a></li> |
| <li><a href="SnowflakeIO.Write.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#fields.inherited.from.class.org.apache.beam.sdk.transforms.PTransform">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
