blob: a6b769c33c76d2fde2933838bd5f1c7390fb96b3 [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 -->
<title>org.apache.beam.sdk.io.singlestore (Apache Beam 2.47.0)</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="org.apache.beam.sdk.io.singlestore (Apache Beam 2.47.0)";
}
}
catch(err) {
}
//-->
</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 class="navBarCell1Rev">Package</li>
<li>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/redis/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../org/apache/beam/sdk/io/singlestore/schematransform/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/beam/sdk/io/singlestore/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<p><a href="../../../../../../org/apache/beam/sdk/annotations/Experimental.html" title="annotation in org.apache.beam.sdk.annotations">@Experimental</a>(<a href="../../../../../../org/apache/beam/sdk/annotations/Experimental.html#value--">value</a>=<a href="../../../../../../org/apache/beam/sdk/annotations/Experimental.Kind.html#SOURCE_SINK">SOURCE_SINK</a>)
</p>
<h1 title="Package" class="title">Package&nbsp;org.apache.beam.sdk.io.singlestore</h1>
<div class="docSummary">
<div class="block">Transforms for reading and writing from SingleStoreDB.</div>
</div>
<p>See:&nbsp;<a href="#package.description">Description</a></p>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/singlestore/SingleStoreIO.RowMapper.html" title="interface in org.apache.beam.sdk.io.singlestore">SingleStoreIO.RowMapper</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">An interface used by <a href="../../../../../../org/apache/beam/sdk/io/singlestore/SingleStoreIO.Read.html" title="class in org.apache.beam.sdk.io.singlestore"><code>SingleStoreIO.Read</code></a> and <a href="../../../../../../org/apache/beam/sdk/io/singlestore/SingleStoreIO.ReadWithPartitions.html" title="class in org.apache.beam.sdk.io.singlestore"><code>SingleStoreIO.ReadWithPartitions</code></a> for converting each row of the
<code>ResultSet</code> into an element of the resulting <a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/singlestore/SingleStoreIO.RowMapperWithCoder.html" title="interface in org.apache.beam.sdk.io.singlestore">SingleStoreIO.RowMapperWithCoder</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">A RowMapper that provides a Coder for resulting PCollection.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/singlestore/SingleStoreIO.RowMapperWithInit.html" title="interface in org.apache.beam.sdk.io.singlestore">SingleStoreIO.RowMapperWithInit</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">A RowMapper that requires initialization.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/singlestore/SingleStoreIO.StatementPreparator.html" title="interface in org.apache.beam.sdk.io.singlestore">SingleStoreIO.StatementPreparator</a></td>
<td class="colLast">
<div class="block">An interface used by the SingleStoreIO <a href="../../../../../../org/apache/beam/sdk/io/singlestore/SingleStoreIO.Read.html" title="class in org.apache.beam.sdk.io.singlestore"><code>SingleStoreIO.Read</code></a> to set the parameters of the <code>PreparedStatement</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/singlestore/SingleStoreIO.UserDataMapper.html" title="interface in org.apache.beam.sdk.io.singlestore">SingleStoreIO.UserDataMapper</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">An interface used by the SingleStoreIO <a href="../../../../../../org/apache/beam/sdk/io/singlestore/SingleStoreIO.Write.html" title="class in org.apache.beam.sdk.io.singlestore"><code>SingleStoreIO.Write</code></a> to map a data from each element of <a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a> to a List of Strings.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/singlestore/SingleStoreIO.html" title="class in org.apache.beam.sdk.io.singlestore">SingleStoreIO</a></td>
<td class="colLast">
<div class="block">IO to read and write data on SingleStoreDB.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/singlestore/SingleStoreIO.DataSourceConfiguration.html" title="class in org.apache.beam.sdk.io.singlestore">SingleStoreIO.DataSourceConfiguration</a></td>
<td class="colLast">
<div class="block">A POJO describing a SingleStoreDB <code>DataSource</code> by providing all properties needed to
create it.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/singlestore/SingleStoreIO.Read.html" title="class in org.apache.beam.sdk.io.singlestore">SingleStoreIO.Read</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">A <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a> for reading data from SingleStoreDB.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/singlestore/SingleStoreIO.ReadWithPartitions.html" title="class in org.apache.beam.sdk.io.singlestore">SingleStoreIO.ReadWithPartitions</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">A <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a> for reading data from SingleStoreDB.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/singlestore/SingleStoreIO.Write.html" title="class in org.apache.beam.sdk.io.singlestore">SingleStoreIO.Write</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">A <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a> for writing data to SingleStoreDB.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation">
<caption><span>Exception Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Exception</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/singlestore/SingleStoreIO.Read.SingleStoreRowMapperInitializationException.html" title="class in org.apache.beam.sdk.io.singlestore">SingleStoreIO.Read.SingleStoreRowMapperInitializationException</a></td>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package org.apache.beam.sdk.io.singlestore Description">Package org.apache.beam.sdk.io.singlestore Description</h2>
<div class="block">Transforms for reading and writing from SingleStoreDB.</div>
</div>
<!-- ======= 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 class="navBarCell1Rev">Package</li>
<li>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/redis/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../org/apache/beam/sdk/io/singlestore/schematransform/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/beam/sdk/io/singlestore/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>