Google Git
Sign in
apache / beam-site / 8066db78465c0d76bfe854be06941aea4657c8d5 / . / javadoc / javadoc / org / apache / beam / sdk / extensions / sql / SqlTransform.html
blob: 99f72dcdfd6c2239c3b2e75344f9563d230282ec [file] [log] [blame]
<!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 (1.8.0_181-google-v7) on Mon Jan 27 16:42:28 PST 2020 -->
<title>SqlTransform (Apache Beam 2.20.0-SNAPSHOT)</title>
<meta name="date" content="2020-01-27">
<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="SqlTransform (Apache Beam 2.20.0-SNAPSHOT)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":9,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/extensions/sql/BeamSqlUdf.html" title="interface in org.apache.beam.sdk.extensions.sql"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/beam/sdk/extensions/sql/TableNameExtractionUtils.html" title="class in org.apache.beam.sdk.extensions.sql"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/beam/sdk/extensions/sql/SqlTransform.html" target="_top">Frames</a></li>
<li><a href="SqlTransform.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.org.apache.beam.sdk.transforms.PTransform">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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.extensions.sql</div>
<h2 title="Class SqlTransform" class="title">Class SqlTransform</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>&lt;<a href="../../../../../../org/apache/beam/sdk/values/PInput.html" title="interface in org.apache.beam.sdk.values">PInput</a>,<a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a>&lt;<a href="../../../../../../org/apache/beam/sdk/values/Row.html" title="class in org.apache.beam.sdk.values">Row</a>&gt;&gt;</li>
<li>
<ul class="inheritance">
<li>org.apache.beam.sdk.extensions.sql.SqlTransform</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>
<hr>
<br>
<pre><a href="../../../../../../org/apache/beam/sdk/annotations/Experimental.html" title="annotation in org.apache.beam.sdk.annotations">@Experimental</a>
public abstract class <span class="typeNameLabel">SqlTransform</span>
extends <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a>&lt;<a href="../../../../../../org/apache/beam/sdk/values/PInput.html" title="interface in org.apache.beam.sdk.values">PInput</a>,<a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a>&lt;<a href="../../../../../../org/apache/beam/sdk/values/Row.html" title="class in org.apache.beam.sdk.values">Row</a>&gt;&gt;</pre>
<div class="block"><a href="../../../../../../org/apache/beam/sdk/extensions/sql/SqlTransform.html" title="class in org.apache.beam.sdk.extensions.sql"><code>SqlTransform</code></a> is the DSL interface of Beam SQL. It translates a SQL query as a <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a>, so developers can use standard SQL queries in a Beam pipeline.
<h1>Beam SQL DSL usage:</h1>
<p>A typical pipeline with Beam SQL DSL is:
<pre><code>
PipelineOptions options = PipelineOptionsFactory.create();
Pipeline p = Pipeline.create(options);
//create table from TextIO;
PCollection&lt;Row&gt; inputTableA = p.apply(TextIO.read().from("/my/input/patha")).apply(...);
PCollection&lt;Row&gt; inputTableB = p.apply(TextIO.read().from("/my/input/pathb")).apply(...);
//run a simple query, and register the output as a table in BeamSql;
String sql1 = "select MY_FUNC(c1), c2 from PCOLLECTION";
PCollection&lt;Row&gt; outputTableA = inputTableA.apply(
SqlTransform
.query(sql1)
.addUdf("MY_FUNC", MY_FUNC.class, "FUNC");
//run a JOIN with one table from TextIO, and one table from another query
PCollection&lt;Row&gt; outputTableB =
PCollectionTuple
.of(new TupleTag&lt;&gt;("TABLE_O_A"), outputTableA)
.and(new TupleTag&lt;&gt;("TABLE_B"), inputTableB)
.apply(SqlTransform.query("select * from TABLE_O_A JOIN TABLE_B where ..."));
//output the final result with TextIO
outputTableB.apply(...).apply(TextIO.write().to("/my/output/path"));
p.run().waitUntilFinish();
</code></pre></div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../serialized-form.html#org.apache.beam.sdk.extensions.sql.SqlTransform">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&nbsp;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></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">&nbsp;</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/extensions/sql/SqlTransform.html#SqlTransform--">SqlTransform</a></span>()</code>&nbsp;</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">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</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/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a>&lt;<a href="../../../../../../org/apache/beam/sdk/values/Row.html" title="class in org.apache.beam.sdk.values">Row</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/extensions/sql/SqlTransform.html#expand-org.apache.beam.sdk.values.PInput-">expand</a></span>(<a href="../../../../../../org/apache/beam/sdk/values/PInput.html" title="interface in org.apache.beam.sdk.values">PInput</a>&nbsp;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>static <a href="../../../../../../org/apache/beam/sdk/extensions/sql/SqlTransform.html" title="class in org.apache.beam.sdk.extensions.sql">SqlTransform</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/extensions/sql/SqlTransform.html#query-java.lang.String-">query</a></span>(java.lang.String&nbsp;queryString)</code>
<div class="block">Returns a <a href="../../../../../../org/apache/beam/sdk/extensions/sql/SqlTransform.html" title="class in org.apache.beam.sdk.extensions.sql"><code>SqlTransform</code></a> representing an equivalent execution plan.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/extensions/sql/SqlTransform.html" title="class in org.apache.beam.sdk.extensions.sql">SqlTransform</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/extensions/sql/SqlTransform.html#registerUdaf-java.lang.String-org.apache.beam.sdk.transforms.Combine.CombineFn-">registerUdaf</a></span>(java.lang.String&nbsp;functionName,
<a href="../../../../../../org/apache/beam/sdk/transforms/Combine.CombineFn.html" title="class in org.apache.beam.sdk.transforms">Combine.CombineFn</a>&nbsp;combineFn)</code>
<div class="block">register a <code>Combine.CombineFn</code> as UDAF function used in this query.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/extensions/sql/SqlTransform.html" title="class in org.apache.beam.sdk.extensions.sql">SqlTransform</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/extensions/sql/SqlTransform.html#registerUdf-java.lang.String-java.lang.Class-">registerUdf</a></span>(java.lang.String&nbsp;functionName,
java.lang.Class&lt;? extends <a href="../../../../../../org/apache/beam/sdk/extensions/sql/BeamSqlUdf.html" title="interface in org.apache.beam.sdk.extensions.sql">BeamSqlUdf</a>&gt;&nbsp;clazz)</code>
<div class="block">register a UDF function used in this query.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/extensions/sql/SqlTransform.html" title="class in org.apache.beam.sdk.extensions.sql">SqlTransform</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/extensions/sql/SqlTransform.html#registerUdf-java.lang.String-org.apache.beam.sdk.transforms.SerializableFunction-">registerUdf</a></span>(java.lang.String&nbsp;functionName,
<a href="../../../../../../org/apache/beam/sdk/transforms/SerializableFunction.html" title="interface in org.apache.beam.sdk.transforms">SerializableFunction</a>&nbsp;sfn)</code>
<div class="block">Register <a href="../../../../../../org/apache/beam/sdk/transforms/SerializableFunction.html" title="interface in org.apache.beam.sdk.transforms"><code>SerializableFunction</code></a> as a UDF function used in this query.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/extensions/sql/SqlTransform.html" title="class in org.apache.beam.sdk.extensions.sql">SqlTransform</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/extensions/sql/SqlTransform.html#withAutoUdfUdafLoad-boolean-">withAutoUdfUdafLoad</a></span>(boolean&nbsp;autoUdfUdafLoad)</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/extensions/sql/SqlTransform.html" title="class in org.apache.beam.sdk.extensions.sql">SqlTransform</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/extensions/sql/SqlTransform.html#withDefaultTableProvider-java.lang.String-org.apache.beam.sdk.extensions.sql.meta.provider.TableProvider-">withDefaultTableProvider</a></span>(java.lang.String&nbsp;name,
<a href="../../../../../../org/apache/beam/sdk/extensions/sql/meta/provider/TableProvider.html" title="interface in org.apache.beam.sdk.extensions.sql.meta.provider">TableProvider</a>&nbsp;tableProvider)</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/extensions/sql/SqlTransform.html" title="class in org.apache.beam.sdk.extensions.sql">SqlTransform</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/extensions/sql/SqlTransform.html#withNamedParameters-java.util.Map-">withNamedParameters</a></span>(java.util.Map&nbsp;parameters)</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/extensions/sql/SqlTransform.html" title="class in org.apache.beam.sdk.extensions.sql">SqlTransform</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/extensions/sql/SqlTransform.html#withPositionalParameters-java.util.List-">withPositionalParameters</a></span>(java.util.List&nbsp;parameters)</code>&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/extensions/sql/SqlTransform.html" title="class in org.apache.beam.sdk.extensions.sql">SqlTransform</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/extensions/sql/SqlTransform.html#withTableProvider-java.lang.String-org.apache.beam.sdk.extensions.sql.meta.provider.TableProvider-">withTableProvider</a></span>(java.lang.String&nbsp;name,
<a href="../../../../../../org/apache/beam/sdk/extensions/sql/meta/provider/TableProvider.html" title="interface in org.apache.beam.sdk.extensions.sql.meta.provider">TableProvider</a>&nbsp;tableProvider)</code>&nbsp;</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&nbsp;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#populateDisplayData-org.apache.beam.sdk.transforms.display.DisplayData.Builder-">populateDisplayData</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&nbsp;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="SqlTransform--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SqlTransform</h4>
<pre>public&nbsp;SqlTransform()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="expand-org.apache.beam.sdk.values.PInput-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>expand</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a>&lt;<a href="../../../../../../org/apache/beam/sdk/values/Row.html" title="class in org.apache.beam.sdk.values">Row</a>&gt;&nbsp;expand(<a href="../../../../../../org/apache/beam/sdk/values/PInput.html" title="interface in org.apache.beam.sdk.values">PInput</a>&nbsp;input)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<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>&nbsp;in class&nbsp;<code><a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms">PTransform</a>&lt;<a href="../../../../../../org/apache/beam/sdk/values/PInput.html" title="interface in org.apache.beam.sdk.values">PInput</a>,<a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values">PCollection</a>&lt;<a href="../../../../../../org/apache/beam/sdk/values/Row.html" title="class in org.apache.beam.sdk.values">Row</a>&gt;&gt;</code></dd>
</dl>
</li>
</ul>
<a name="query-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>query</h4>
<pre>public static&nbsp;<a href="../../../../../../org/apache/beam/sdk/extensions/sql/SqlTransform.html" title="class in org.apache.beam.sdk.extensions.sql">SqlTransform</a>&nbsp;query(java.lang.String&nbsp;queryString)</pre>
<div class="block">Returns a <a href="../../../../../../org/apache/beam/sdk/extensions/sql/SqlTransform.html" title="class in org.apache.beam.sdk.extensions.sql"><code>SqlTransform</code></a> representing an equivalent execution plan.
<p>The <a href="../../../../../../org/apache/beam/sdk/extensions/sql/SqlTransform.html" title="class in org.apache.beam.sdk.extensions.sql"><code>SqlTransform</code></a> can be applied to a <a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a> or <a href="../../../../../../org/apache/beam/sdk/values/PCollectionTuple.html" title="class in org.apache.beam.sdk.values"><code>PCollectionTuple</code></a>
representing all the input tables.
<p>The <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a> outputs a <a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a> of <a href="../../../../../../org/apache/beam/sdk/values/Row.html" title="class in org.apache.beam.sdk.values"><code>Row</code></a>.
<p>If the <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a> is applied to <a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a> then it gets registered with
name <em>PCOLLECTION</em>.
<p>If the <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a> is applied to <a href="../../../../../../org/apache/beam/sdk/values/PCollectionTuple.html" title="class in org.apache.beam.sdk.values"><code>PCollectionTuple</code></a> then <a href="../../../../../../org/apache/beam/sdk/values/TupleTag.html#getId--"><code>TupleTag.getId()</code></a> is used as the corresponding <a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a>s name.
<ul>
<li>If the sql query only uses a subset of tables from the upstream <a href="../../../../../../org/apache/beam/sdk/values/PCollectionTuple.html" title="class in org.apache.beam.sdk.values"><code>PCollectionTuple</code></a>,
this is valid;
<li>If the sql query references a table not included in the upstream <a href="../../../../../../org/apache/beam/sdk/values/PCollectionTuple.html" title="class in org.apache.beam.sdk.values"><code>PCollectionTuple</code></a>, an <code>IllegalStateException</code> is thrown during query validati on;
<li>Always, tables from the upstream <a href="../../../../../../org/apache/beam/sdk/values/PCollectionTuple.html" title="class in org.apache.beam.sdk.values"><code>PCollectionTuple</code></a> are only valid in the scope of
the current query call.
</ul></div>
</li>
</ul>
<a name="withTableProvider-java.lang.String-org.apache.beam.sdk.extensions.sql.meta.provider.TableProvider-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withTableProvider</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/beam/sdk/extensions/sql/SqlTransform.html" title="class in org.apache.beam.sdk.extensions.sql">SqlTransform</a>&nbsp;withTableProvider(java.lang.String&nbsp;name,
<a href="../../../../../../org/apache/beam/sdk/extensions/sql/meta/provider/TableProvider.html" title="interface in org.apache.beam.sdk.extensions.sql.meta.provider">TableProvider</a>&nbsp;tableProvider)</pre>
</li>
</ul>
<a name="withDefaultTableProvider-java.lang.String-org.apache.beam.sdk.extensions.sql.meta.provider.TableProvider-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withDefaultTableProvider</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/beam/sdk/extensions/sql/SqlTransform.html" title="class in org.apache.beam.sdk.extensions.sql">SqlTransform</a>&nbsp;withDefaultTableProvider(java.lang.String&nbsp;name,
<a href="../../../../../../org/apache/beam/sdk/extensions/sql/meta/provider/TableProvider.html" title="interface in org.apache.beam.sdk.extensions.sql.meta.provider">TableProvider</a>&nbsp;tableProvider)</pre>
</li>
</ul>
<a name="withNamedParameters-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withNamedParameters</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/beam/sdk/extensions/sql/SqlTransform.html" title="class in org.apache.beam.sdk.extensions.sql">SqlTransform</a>&nbsp;withNamedParameters(java.util.Map&nbsp;parameters)</pre>
</li>
</ul>
<a name="withPositionalParameters-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withPositionalParameters</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/beam/sdk/extensions/sql/SqlTransform.html" title="class in org.apache.beam.sdk.extensions.sql">SqlTransform</a>&nbsp;withPositionalParameters(java.util.List&nbsp;parameters)</pre>
</li>
</ul>
<a name="withAutoUdfUdafLoad-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withAutoUdfUdafLoad</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/beam/sdk/extensions/sql/SqlTransform.html" title="class in org.apache.beam.sdk.extensions.sql">SqlTransform</a>&nbsp;withAutoUdfUdafLoad(boolean&nbsp;autoUdfUdafLoad)</pre>
</li>
</ul>
<a name="registerUdf-java.lang.String-java.lang.Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>registerUdf</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/beam/sdk/extensions/sql/SqlTransform.html" title="class in org.apache.beam.sdk.extensions.sql">SqlTransform</a>&nbsp;registerUdf(java.lang.String&nbsp;functionName,
java.lang.Class&lt;? extends <a href="../../../../../../org/apache/beam/sdk/extensions/sql/BeamSqlUdf.html" title="interface in org.apache.beam.sdk.extensions.sql">BeamSqlUdf</a>&gt;&nbsp;clazz)</pre>
<div class="block">register a UDF function used in this query.
<p>Refer to <a href="../../../../../../org/apache/beam/sdk/extensions/sql/BeamSqlUdf.html" title="interface in org.apache.beam.sdk.extensions.sql"><code>BeamSqlUdf</code></a> for more about how to implement a UDF in BeamSql.</div>
</li>
</ul>
<a name="registerUdf-java.lang.String-org.apache.beam.sdk.transforms.SerializableFunction-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>registerUdf</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/beam/sdk/extensions/sql/SqlTransform.html" title="class in org.apache.beam.sdk.extensions.sql">SqlTransform</a>&nbsp;registerUdf(java.lang.String&nbsp;functionName,
<a href="../../../../../../org/apache/beam/sdk/transforms/SerializableFunction.html" title="interface in org.apache.beam.sdk.transforms">SerializableFunction</a>&nbsp;sfn)</pre>
<div class="block">Register <a href="../../../../../../org/apache/beam/sdk/transforms/SerializableFunction.html" title="interface in org.apache.beam.sdk.transforms"><code>SerializableFunction</code></a> as a UDF function used in this query. Note, <a href="../../../../../../org/apache/beam/sdk/transforms/SerializableFunction.html" title="interface in org.apache.beam.sdk.transforms"><code>SerializableFunction</code></a> must have a constructor without arguments.</div>
</li>
</ul>
<a name="registerUdaf-java.lang.String-org.apache.beam.sdk.transforms.Combine.CombineFn-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>registerUdaf</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/beam/sdk/extensions/sql/SqlTransform.html" title="class in org.apache.beam.sdk.extensions.sql">SqlTransform</a>&nbsp;registerUdaf(java.lang.String&nbsp;functionName,
<a href="../../../../../../org/apache/beam/sdk/transforms/Combine.CombineFn.html" title="class in org.apache.beam.sdk.transforms">Combine.CombineFn</a>&nbsp;combineFn)</pre>
<div class="block">register a <code>Combine.CombineFn</code> as UDAF function used in this query.</div>
</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/extensions/sql/BeamSqlUdf.html" title="interface in org.apache.beam.sdk.extensions.sql"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/beam/sdk/extensions/sql/TableNameExtractionUtils.html" title="class in org.apache.beam.sdk.extensions.sql"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/beam/sdk/extensions/sql/SqlTransform.html" target="_top">Frames</a></li>
<li><a href="SqlTransform.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.org.apache.beam.sdk.transforms.PTransform">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>