| <!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>JdbcIO (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="JdbcIO (Apache Beam 2.38.0-SNAPSHOT)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static 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>Prev Class</li> |
| <li><a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.DataSourceConfiguration.html" title="class in org.apache.beam.sdk.io.jdbc"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/beam/sdk/io/jdbc/JdbcIO.html" target="_top">Frames</a></li> |
| <li><a href="JdbcIO.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><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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.jdbc</div> |
| <h2 title="Class JdbcIO" class="title">Class JdbcIO</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.beam.sdk.io.jdbc.JdbcIO</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre><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>) |
| public class <span class="typeNameLabel">JdbcIO</span> |
| extends java.lang.Object</pre> |
| <div class="block">IO to read and write data on JDBC. |
| |
| <h3>Reading from JDBC datasource</h3> |
| |
| <p>JdbcIO source returns a bounded collection of <code>T</code> as a <code>PCollection<T></code>. T is the |
| type returned by the provided <a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.RowMapper.html" title="interface in org.apache.beam.sdk.io.jdbc"><code>JdbcIO.RowMapper</code></a>. |
| |
| <p>To configure the JDBC source, you have to provide 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> using<br> |
| 1. <a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.DataSourceConfiguration.html#create-javax.sql.DataSource-"><code>JdbcIO.DataSourceConfiguration.create(DataSource)</code></a>(which must be <code>Serializable</code>);<br> |
| 2. or <a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.DataSourceConfiguration.html#create-java.lang.String-java.lang.String-"><code>JdbcIO.DataSourceConfiguration.create(String, String)</code></a>(driver class name and url). |
| Optionally, <a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.DataSourceConfiguration.html#withUsername-java.lang.String-"><code>JdbcIO.DataSourceConfiguration.withUsername(String)</code></a> and <a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.DataSourceConfiguration.html#withPassword-java.lang.String-"><code>JdbcIO.DataSourceConfiguration.withPassword(String)</code></a> allows you to define username and password. |
| |
| <p>For example: |
| |
| <pre><code> |
| pipeline.apply(JdbcIO.<KV<Integer, String>>read() |
| .withDataSourceConfiguration(JdbcIO.DataSourceConfiguration.create( |
| "com.mysql.jdbc.Driver", "jdbc:mysql://hostname:3306/mydb") |
| .withUsername("username") |
| .withPassword("password")) |
| .withQuery("select id,name from Person") |
| .withRowMapper(new JdbcIO.RowMapper<KV<Integer, String>>() { |
| public KV<Integer, String> mapRow(ResultSet resultSet) throws Exception { |
| return KV.of(resultSet.getInt(1), resultSet.getString(2)); |
| } |
| }) |
| ); |
| </code></pre> |
| |
| <p>Query parameters can be configured using a user-provided <a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.StatementPreparator.html" title="interface in org.apache.beam.sdk.io.jdbc"><code>JdbcIO.StatementPreparator</code></a>. For |
| example: |
| |
| <pre><code> |
| pipeline.apply(JdbcIO.<KV<Integer, String>>read() |
| .withDataSourceConfiguration(JdbcIO.DataSourceConfiguration.create( |
| "com.mysql.jdbc.Driver", "jdbc:mysql://hostname:3306/mydb", |
| "username", "password")) |
| .withQuery("select id,name from Person where name = ?") |
| .withStatementPreparator(new JdbcIO.StatementPreparator() { |
| public void setParameters(PreparedStatement preparedStatement) throws Exception { |
| preparedStatement.setString(1, "Darwin"); |
| } |
| }) |
| .withRowMapper(new JdbcIO.RowMapper<KV<Integer, String>>() { |
| public KV<Integer, String> mapRow(ResultSet resultSet) throws Exception { |
| return KV.of(resultSet.getInt(1), resultSet.getString(2)); |
| } |
| }) |
| ); |
| </code></pre> |
| |
| <p>To customize the building of the <code>DataSource</code> we can provide a <a href="../../../../../../org/apache/beam/sdk/transforms/SerializableFunction.html" title="interface in org.apache.beam.sdk.transforms"><code>SerializableFunction</code></a>. For example if you need to provide a <code>PoolingDataSource</code> from an |
| existing <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>: you can use a <a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.PoolableDataSourceProvider.html" title="class in org.apache.beam.sdk.io.jdbc"><code>JdbcIO.PoolableDataSourceProvider</code></a>: |
| |
| <pre><code> |
| pipeline.apply(JdbcIO.<KV<Integer, String>>read() |
| .withDataSourceProviderFn(JdbcIO.PoolableDataSourceProvider.of( |
| JdbcIO.DataSourceConfiguration.create( |
| "com.mysql.jdbc.Driver", "jdbc:mysql://hostname:3306/mydb", |
| "username", "password"))) |
| // ... |
| ); |
| </code></pre> |
| |
| <p>By default, the provided function requests a DataSource per execution thread. In some |
| circumstances this can quickly overwhelm the database by requesting too many connections. In that |
| case you should look into sharing a single instance of a <code>PoolingDataSource</code> across all the |
| execution threads. For example: |
| |
| <pre><code> |
| private static class MyDataSourceProviderFn implements SerializableFunction<Void, DataSource> { |
| private static transient DataSource dataSource; |
| |
| @Override |
| public synchronized DataSource apply(Void input) { |
| if (dataSource == null) { |
| dataSource = ... build data source ... |
| } |
| return dataSource; |
| } |
| } |
| |
| pipeline.apply(JdbcIO.<KV<Integer, String>>read() |
| .withDataSourceProviderFn(new MyDataSourceProviderFn()) |
| // ... |
| ); |
| </code></pre> |
| |
| <h4>Parallel reading from a JDBC datasource</h4> |
| |
| <p>Beam supports partitioned reading of all data from a table. Automatic partitioning is |
| supported for a few data types: <code>Long</code>, <a href="https://static.javadoc.io/joda-time/joda-time/2.10.10/org/joda/time/DateTime.html?is-external=true" title="class or interface in org.joda.time"><code>DateTime</code></a>, <code>String</code>. To |
| enable this, use <a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.html#readWithPartitions-org.apache.beam.sdk.values.TypeDescriptor-"><code>readWithPartitions(TypeDescriptor)</code></a>. |
| |
| <p>The partitioning scheme depends on these parameters, which can be user-provided, or |
| automatically inferred by Beam (for the supported types): |
| |
| <ul> |
| <li>Upper bound |
| <li>Lower bound |
| <li>Number of partitions - when auto-inferred, the number of partitions defaults to the square |
| root of the number of rows divided by 5 (i.e.: <code>Math.floor(Math.sqrt(numRows) / 5)</code>). |
| </ul> |
| |
| <p>To trigger auto-inference of these parameters, the user just needs to not provide them. To |
| infer them automatically, Beam runs either of these statements: |
| |
| <ul> |
| <li><code>SELECT min(column), max(column), COUNT(*) from table</code> when none of the parameters is |
| passed to the transform. |
| <li><code>SELECT min(column), max(column) from table</code> when only number of partitions is |
| provided, but not upper or lower bounds. |
| </ul> |
| |
| <p><b>Should I use this transform?</b> Consider using this transform in the following situations: |
| |
| <ul> |
| <li>The partitioning column is indexed. This will help speed up the range queries |
| <li><b>Use auto-inference</b> if the queries for bound and partition inference are efficient to |
| execute in your DBMS. |
| <li>The distribution of data over the partitioning column is <i>roughly uniform</i>. Uniformity |
| is not mandatory, but this transform will work best in that situation. |
| </ul> |
| |
| <p>The following example shows usage of <b>auto-inferred ranges, number of partitions, and |
| schema</b> |
| |
| <pre><code> |
| pipeline.apply(JdbcIO.<Row>readWithPartitions() |
| .withDataSourceConfiguration(JdbcIO.DataSourceConfiguration.create( |
| "com.mysql.jdbc.Driver", "jdbc:mysql://hostname:3306/mydb") |
| .withUsername("username") |
| .withPassword("password")) |
| .withTable("Person") |
| .withPartitionColumn("id") |
| .withRowOutput() |
| ); |
| </code></pre> |
| |
| <p>Instead of a full table you could also use a subquery in parentheses. The subquery can be |
| specified using Table option instead and partition columns can be qualified using the subquery |
| alias provided as part of Table. <b>Note</b> that a subquery may not perform as well with |
| auto-inferred ranges and partitions, because it may not rely on indices to speed up the |
| partitioning. |
| |
| <pre><code> |
| pipeline.apply(JdbcIO.<KV<Integer, String>>readWithPartitions() |
| .withDataSourceConfiguration(JdbcIO.DataSourceConfiguration.create( |
| "com.mysql.jdbc.Driver", "jdbc:mysql://hostname:3306/mydb") |
| .withUsername("username") |
| .withPassword("password")) |
| .withTable("(select id, name from Person) as subq") |
| .withPartitionColumn("id") |
| .withLowerBound(0) |
| .withUpperBound(1000) |
| .withNumPartitions(5) |
| .withRowMapper(new JdbcIO.RowMapper<KV<Integer, String>>() { |
| public KV<Integer, String> mapRow(ResultSet resultSet) throws Exception { |
| return KV.of(resultSet.getInt(1), resultSet.getString(2)); |
| } |
| }) |
| ); |
| </code></pre> |
| |
| <h3>Writing to JDBC datasource</h3> |
| |
| <p>JDBC sink supports writing records into a database. It writes a <a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a> to the |
| database by converting each T into a <code>PreparedStatement</code> via a user-provided <a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.PreparedStatementSetter.html" title="interface in org.apache.beam.sdk.io.jdbc"><code>JdbcIO.PreparedStatementSetter</code></a>. |
| |
| <p>Like the source, to configure the sink, you have to provide 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>. |
| |
| <pre><code> |
| pipeline |
| .apply(...) |
| .apply(JdbcIO.<KV<Integer, String>>write() |
| .withDataSourceConfiguration(JdbcIO.DataSourceConfiguration.create( |
| "com.mysql.jdbc.Driver", "jdbc:mysql://hostname:3306/mydb") |
| .withUsername("username") |
| .withPassword("password")) |
| .withStatement("insert into Person values(?, ?)") |
| .withPreparedStatementSetter(new JdbcIO.PreparedStatementSetter<KV<Integer, String>>() { |
| public void setParameters(KV<Integer, String> element, PreparedStatement query) |
| throws SQLException { |
| query.setInt(1, element.getKey()); |
| query.setString(2, element.getValue()); |
| } |
| }) |
| ); |
| </code></pre> |
| |
| <p>NB: in case of transient failures, Beam runners may execute parts of JdbcIO.Write multiple |
| times for fault tolerance. Because of that, you should avoid using <code>INSERT</code> statements, |
| since that risks duplicating records in the database, or failing due to primary key conflicts. |
| Consider using <a href="https://en.wikipedia.org/wiki/Merge_(SQL)">MERGE ("upsert") |
| statements</a> supported by your database instead.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Class and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.DataSourceConfiguration.html" title="class in org.apache.beam.sdk.io.jdbc">JdbcIO.DataSourceConfiguration</a></span></code> |
| <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="rowColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.DataSourceProviderFromDataSourceConfiguration.html" title="class in org.apache.beam.sdk.io.jdbc">JdbcIO.DataSourceProviderFromDataSourceConfiguration</a></span></code> |
| <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="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.DefaultRetryStrategy.html" title="class in org.apache.beam.sdk.io.jdbc">JdbcIO.DefaultRetryStrategy</a></span></code> |
| <div class="block">This is the default <code>Predicate</code> we use to detect DeadLock.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.PoolableDataSourceProvider.html" title="class in org.apache.beam.sdk.io.jdbc">JdbcIO.PoolableDataSourceProvider</a></span></code> |
| <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="altColor"> |
| <td class="colFirst"><code>static interface </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.PreparedStatementSetter.html" title="interface in org.apache.beam.sdk.io.jdbc">JdbcIO.PreparedStatementSetter</a><<a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.PreparedStatementSetter.html" title="type parameter in JdbcIO.PreparedStatementSetter">T</a>></span></code> |
| <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"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.Read.html" title="class in org.apache.beam.sdk.io.jdbc">JdbcIO.Read</a><<a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.Read.html" title="type parameter in JdbcIO.Read">T</a>></span></code> |
| <div class="block">Implementation of <a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.html#read--"><code>read()</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.ReadAll.html" title="class in org.apache.beam.sdk.io.jdbc">JdbcIO.ReadAll</a><<a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.ReadAll.html" title="type parameter in JdbcIO.ReadAll">ParameterT</a>,<a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.ReadAll.html" title="type parameter in JdbcIO.ReadAll">OutputT</a>></span></code> |
| <div class="block">Implementation of <a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.html#readAll--"><code>readAll()</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.ReadRows.html" title="class in org.apache.beam.sdk.io.jdbc">JdbcIO.ReadRows</a></span></code> |
| <div class="block">Implementation of <a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.html#readRows--"><code>readRows()</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.ReadWithPartitions.html" title="class in org.apache.beam.sdk.io.jdbc">JdbcIO.ReadWithPartitions</a><<a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.ReadWithPartitions.html" title="type parameter in JdbcIO.ReadWithPartitions">T</a>,<a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.ReadWithPartitions.html" title="type parameter in JdbcIO.ReadWithPartitions">PartitionColumnT</a>></span></code> |
| <div class="block">Implementation of <a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.html#readWithPartitions-org.apache.beam.sdk.values.TypeDescriptor-"><code>readWithPartitions(org.apache.beam.sdk.values.TypeDescriptor<PartitionColumnT>)</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.RetryConfiguration.html" title="class in org.apache.beam.sdk.io.jdbc">JdbcIO.RetryConfiguration</a></span></code> |
| <div class="block">Builder used to help with retry configuration for <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="altColor"> |
| <td class="colFirst"><code>static interface </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.RetryStrategy.html" title="interface in org.apache.beam.sdk.io.jdbc">JdbcIO.RetryStrategy</a></span></code> |
| <div class="block">An interface used to control if we retry the statements when a <code>SQLException</code> occurs.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static interface </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.RowMapper.html" title="interface in org.apache.beam.sdk.io.jdbc">JdbcIO.RowMapper</a><<a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.RowMapper.html" title="type parameter in JdbcIO.RowMapper">T</a>></span></code> |
| <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="altColor"> |
| <td class="colFirst"><code>static interface </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.StatementPreparator.html" title="interface in org.apache.beam.sdk.io.jdbc">JdbcIO.StatementPreparator</a></span></code> |
| <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"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.Write.html" title="class in org.apache.beam.sdk.io.jdbc">JdbcIO.Write</a><<a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.Write.html" title="type parameter in JdbcIO.Write">T</a>></span></code> |
| <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>write()</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.WriteVoid.html" title="class in org.apache.beam.sdk.io.jdbc">JdbcIO.WriteVoid</a><<a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.WriteVoid.html" title="type parameter in JdbcIO.WriteVoid">T</a>></span></code> |
| <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="rowColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.WriteWithResults.html" title="class in org.apache.beam.sdk.io.jdbc">JdbcIO.WriteWithResults</a><<a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.WriteWithResults.html" title="type parameter in JdbcIO.WriteWithResults">T</a>,<a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.WriteWithResults.html" title="type parameter in JdbcIO.WriteWithResults">V</a> extends <a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcWriteResult.html" title="class in org.apache.beam.sdk.io.jdbc">JdbcWriteResult</a>></span></code> |
| <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> |
| </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="t1" class="tableTab"><span><a href="javascript:show(1);">Static 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>static <T> <a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.Read.html" title="class in org.apache.beam.sdk.io.jdbc">JdbcIO.Read</a><T></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.html#read--">read</a></span>()</code> |
| <div class="block">Read data from a JDBC datasource.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static <ParameterT,OutputT><br><a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.ReadAll.html" title="class in org.apache.beam.sdk.io.jdbc">JdbcIO.ReadAll</a><ParameterT,OutputT></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.html#readAll--">readAll</a></span>()</code> |
| <div class="block">Like <a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.html#read--"><code>read()</code></a>, but executes multiple instances of the query substituting each element of a |
| <a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a> as query parameters.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.ReadRows.html" title="class in org.apache.beam.sdk.io.jdbc">JdbcIO.ReadRows</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.html#readRows--">readRows</a></span>()</code> |
| <div class="block">Read Beam <a href="../../../../../../org/apache/beam/sdk/values/Row.html" title="class in org.apache.beam.sdk.values"><code>Row</code></a>s from a JDBC data source.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static <T> <a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.ReadWithPartitions.html" title="class in org.apache.beam.sdk.io.jdbc">JdbcIO.ReadWithPartitions</a><T,java.lang.Long></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.html#readWithPartitions--">readWithPartitions</a></span>()</code> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>static <T,PartitionColumnT><br><a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.ReadWithPartitions.html" title="class in org.apache.beam.sdk.io.jdbc">JdbcIO.ReadWithPartitions</a><T,PartitionColumnT></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.html#readWithPartitions-org.apache.beam.sdk.values.TypeDescriptor-">readWithPartitions</a></span>(<a href="../../../../../../org/apache/beam/sdk/values/TypeDescriptor.html" title="class in org.apache.beam.sdk.values">TypeDescriptor</a><PartitionColumnT> partitioningColumnType)</code> |
| <div class="block">Like <a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.html#readAll--"><code>readAll()</code></a>, but executes multiple instances of the query on the same table |
| (subquery) using ranges.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>static <T> <a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.Write.html" title="class in org.apache.beam.sdk.io.jdbc">JdbcIO.Write</a><T></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.html#write--">write</a></span>()</code> |
| <div class="block">Write data to a JDBC datasource.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>static <T> <a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.WriteVoid.html" title="class in org.apache.beam.sdk.io.jdbc">JdbcIO.WriteVoid</a><T></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.html#writeVoid--">writeVoid</a></span>()</code> </td> |
| </tr> |
| </table> |
| <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, toString, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="read--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>read</h4> |
| <pre>public static <T> <a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.Read.html" title="class in org.apache.beam.sdk.io.jdbc">JdbcIO.Read</a><T> read()</pre> |
| <div class="block">Read data from a JDBC datasource.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - Type of the data to be read.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="readRows--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>readRows</h4> |
| <pre><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#SCHEMAS">SCHEMAS</a>) |
| public static <a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.ReadRows.html" title="class in org.apache.beam.sdk.io.jdbc">JdbcIO.ReadRows</a> readRows()</pre> |
| <div class="block">Read Beam <a href="../../../../../../org/apache/beam/sdk/values/Row.html" title="class in org.apache.beam.sdk.values"><code>Row</code></a>s from a JDBC data source.</div> |
| </li> |
| </ul> |
| <a name="readAll--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>readAll</h4> |
| <pre>public static <ParameterT,OutputT> <a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.ReadAll.html" title="class in org.apache.beam.sdk.io.jdbc">JdbcIO.ReadAll</a><ParameterT,OutputT> readAll()</pre> |
| <div class="block">Like <a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.html#read--"><code>read()</code></a>, but executes multiple instances of the query substituting each element of a |
| <a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a> as query parameters.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>ParameterT</code> - Type of the data representing query parameters.</dd> |
| <dd><code>OutputT</code> - Type of the data to be read.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="readWithPartitions-org.apache.beam.sdk.values.TypeDescriptor-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>readWithPartitions</h4> |
| <pre>public static <T,PartitionColumnT> <a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.ReadWithPartitions.html" title="class in org.apache.beam.sdk.io.jdbc">JdbcIO.ReadWithPartitions</a><T,PartitionColumnT> readWithPartitions(<a href="../../../../../../org/apache/beam/sdk/values/TypeDescriptor.html" title="class in org.apache.beam.sdk.values">TypeDescriptor</a><PartitionColumnT> partitioningColumnType)</pre> |
| <div class="block">Like <a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.html#readAll--"><code>readAll()</code></a>, but executes multiple instances of the query on the same table |
| (subquery) using ranges.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - Type of the data to be read.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="readWithPartitions--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>readWithPartitions</h4> |
| <pre>public static <T> <a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.ReadWithPartitions.html" title="class in org.apache.beam.sdk.io.jdbc">JdbcIO.ReadWithPartitions</a><T,java.lang.Long> readWithPartitions()</pre> |
| </li> |
| </ul> |
| <a name="write--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>write</h4> |
| <pre>public static <T> <a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.Write.html" title="class in org.apache.beam.sdk.io.jdbc">JdbcIO.Write</a><T> write()</pre> |
| <div class="block">Write data to a JDBC datasource.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - Type of the data to be written.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="writeVoid--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>writeVoid</h4> |
| <pre>public static <T> <a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.WriteVoid.html" title="class in org.apache.beam.sdk.io.jdbc">JdbcIO.WriteVoid</a><T> writeVoid()</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>Prev Class</li> |
| <li><a href="../../../../../../org/apache/beam/sdk/io/jdbc/JdbcIO.DataSourceConfiguration.html" title="class in org.apache.beam.sdk.io.jdbc"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/beam/sdk/io/jdbc/JdbcIO.html" target="_top">Frames</a></li> |
| <li><a href="JdbcIO.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><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
