Google Git
Sign in
apache / beam-site / 8066db78465c0d76bfe854be06941aea4657c8d5 / . / javadoc / javadoc / org / apache / beam / sdk / io / jdbc / package-summary.html
blob: b73fd5729e1cfeb7b465b716488f86cdacb00c0a [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:35 PST 2020 -->
<title>org.apache.beam.sdk.io.jdbc (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="org.apache.beam.sdk.io.jdbc (Apache Beam 2.20.0-SNAPSHOT)";
}
}
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/hdfs/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../org/apache/beam/sdk/io/jms/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/beam/sdk/io/jdbc/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">
<h1 title="Package" class="title">Package&nbsp;org.apache.beam.sdk.io.jdbc</h1>
<div class="docSummary">
<div class="block">Transforms for reading and writing from JDBC.</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/jdbc/JdbcIO.PreparedStatementSetter.html" title="interface in org.apache.beam.sdk.io.jdbc">JdbcIO.PreparedStatementSetter</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">An interface used by the JdbcIO Write to set the parameters of the <code>PreparedStatement</code>
used to setParameters into the database.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.RetryStrategy.html" title="interface in org.apache.beam.sdk.io.jdbc">JdbcIO.RetryStrategy</a></td>
<td class="colLast">
<div class="block">An interface used to control if we retry the statements when a <code>SQLException</code> occurs.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.RowMapper.html" title="interface in org.apache.beam.sdk.io.jdbc">JdbcIO.RowMapper</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">An interface used by <a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.Read.html" title="class in org.apache.beam.sdk.io.jdbc"><code>JdbcIO.Read</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/jdbc/JdbcIO.StatementPreparator.html" title="interface in org.apache.beam.sdk.io.jdbc">JdbcIO.StatementPreparator</a></td>
<td class="colLast">
<div class="block">An interface used by the JdbcIO Write to set the parameters of the <code>PreparedStatement</code>
used to setParameters into the database.</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/jdbc/JdbcIO.html" title="class in org.apache.beam.sdk.io.jdbc">JdbcIO</a></td>
<td class="colLast">
<div class="block">IO to read and write data on JDBC.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.DataSourceConfiguration.html" title="class in org.apache.beam.sdk.io.jdbc">JdbcIO.DataSourceConfiguration</a></td>
<td class="colLast">
<div class="block">A POJO describing a <code>DataSource</code>, either providing directly a <code>DataSource</code> or all
properties allowing to create a <code>DataSource</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.DataSourceProviderFromDataSourceConfiguration.html" title="class in org.apache.beam.sdk.io.jdbc">JdbcIO.DataSourceProviderFromDataSourceConfiguration</a></td>
<td class="colLast">
<div class="block">Wraps a <a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.DataSourceConfiguration.html" title="class in org.apache.beam.sdk.io.jdbc"><code>JdbcIO.DataSourceConfiguration</code></a> to provide a <code>DataSource</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.DefaultRetryStrategy.html" title="class in org.apache.beam.sdk.io.jdbc">JdbcIO.DefaultRetryStrategy</a></td>
<td class="colLast">
<div class="block">This is the default <code>Predicate</code> we use to detect DeadLock.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.PoolableDataSourceProvider.html" title="class in org.apache.beam.sdk.io.jdbc">JdbcIO.PoolableDataSourceProvider</a></td>
<td class="colLast">
<div class="block">Wraps a <a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.DataSourceConfiguration.html" title="class in org.apache.beam.sdk.io.jdbc"><code>JdbcIO.DataSourceConfiguration</code></a> to provide a <code>PoolingDataSource</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.Read.html" title="class in org.apache.beam.sdk.io.jdbc">JdbcIO.Read</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">Implementation of <a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.html#read--"><code>JdbcIO.read()</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.ReadAll.html" title="class in org.apache.beam.sdk.io.jdbc">JdbcIO.ReadAll</a>&lt;ParameterT,OutputT&gt;</td>
<td class="colLast">
<div class="block">Implementation of <a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.html#readAll--"><code>JdbcIO.readAll()</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.ReadRows.html" title="class in org.apache.beam.sdk.io.jdbc">JdbcIO.ReadRows</a></td>
<td class="colLast">
<div class="block">Implementation of <a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.html#readRows--"><code>JdbcIO.readRows()</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.Write.html" title="class in org.apache.beam.sdk.io.jdbc">JdbcIO.Write</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">This class is used as the default return value of <a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.html#write--"><code>JdbcIO.write()</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.WriteVoid.html" title="class in org.apache.beam.sdk.io.jdbc">JdbcIO.WriteVoid</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> to write to a JDBC datasource.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcUtil.html" title="class in org.apache.beam.sdk.io.jdbc">JdbcUtil</a></td>
<td class="colLast">
<div class="block">Provides utility functions for working with <a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.html" title="class in org.apache.beam.sdk.io.jdbc"><code>JdbcIO</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/jdbc/LogicalTypes.html" title="class in org.apache.beam.sdk.io.jdbc">LogicalTypes</a></td>
<td class="colLast">
<div class="block">Beam <a href="../../../../../../org/apache/beam/sdk/schemas/Schema.LogicalType.html" title="interface in org.apache.beam.sdk.schemas"><code>Schema.LogicalType</code></a> implementations of JDBC types.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/jdbc/LogicalTypes.FixedLengthBytes.html" title="class in org.apache.beam.sdk.io.jdbc">LogicalTypes.FixedLengthBytes</a></td>
<td class="colLast">
<div class="block">Fixed length byte types such as BINARY.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/jdbc/LogicalTypes.FixedLengthString.html" title="class in org.apache.beam.sdk.io.jdbc">LogicalTypes.FixedLengthString</a></td>
<td class="colLast">
<div class="block">Fixed length string types such as CHAR.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/jdbc/LogicalTypes.FixedPrecisionNumeric.html" title="class in org.apache.beam.sdk.io.jdbc">LogicalTypes.FixedPrecisionNumeric</a></td>
<td class="colLast">
<div class="block">Fixed precision numeric types such as NUMERIC.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/jdbc/LogicalTypes.JdbcLogicalType.html" title="class in org.apache.beam.sdk.io.jdbc">LogicalTypes.JdbcLogicalType</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">Base class for JDBC logical types.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/jdbc/LogicalTypes.VariableLengthBytes.html" title="class in org.apache.beam.sdk.io.jdbc">LogicalTypes.VariableLengthBytes</a></td>
<td class="colLast">
<div class="block">Variable length bytes types such as VARBINARY and LONGVARBINARY.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/beam/sdk/io/jdbc/LogicalTypes.VariableLengthString.html" title="class in org.apache.beam.sdk.io.jdbc">LogicalTypes.VariableLengthString</a></td>
<td class="colLast">
<div class="block">Variable length string types such as VARCHAR and LONGVARCHAR.</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/jdbc/BeamSchemaInferenceException.html" title="class in org.apache.beam.sdk.io.jdbc">BeamSchemaInferenceException</a></td>
<td class="colLast">
<div class="block">Exception to signal that inferring the Beam schema from the JDBC source failed.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package org.apache.beam.sdk.io.jdbc Description">Package org.apache.beam.sdk.io.jdbc Description</h2>
<div class="block">Transforms for reading and writing from JDBC.</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/hdfs/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../org/apache/beam/sdk/io/jms/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/beam/sdk/io/jdbc/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>