blob: d29359d8381aaf64ea2732e3da2b95c4d7972cc1 [file] [log] [blame]
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>apache_beam.io.jdbc module &mdash; Apache Beam 2.37.0 documentation</title>
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/language_data.js"></script>
<script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="apache_beam.io.kafka module" href="apache_beam.io.kafka.html" />
<link rel="prev" title="apache_beam.io.iobase module" href="apache_beam.io.iobase.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Apache Beam
</a>
<div class="version">
2.37.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="apache_beam.coders.html">apache_beam.coders package</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.dataframe.html">apache_beam.dataframe package</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="apache_beam.io.html">apache_beam.io package</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="apache_beam.io.html#subpackages">Subpackages</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="apache_beam.io.html#submodules">Submodules</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.avroio.html">apache_beam.io.avroio module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.concat_source.html">apache_beam.io.concat_source module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.debezium.html">apache_beam.io.debezium module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.filebasedsink.html">apache_beam.io.filebasedsink module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.filebasedsource.html">apache_beam.io.filebasedsource module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.fileio.html">apache_beam.io.fileio module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.filesystem.html">apache_beam.io.filesystem module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.filesystemio.html">apache_beam.io.filesystemio module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.filesystems.html">apache_beam.io.filesystems module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.hadoopfilesystem.html">apache_beam.io.hadoopfilesystem module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.iobase.html">apache_beam.io.iobase module</a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="#">apache_beam.io.jdbc module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.kafka.html">apache_beam.io.kafka module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.kinesis.html">apache_beam.io.kinesis module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.localfilesystem.html">apache_beam.io.localfilesystem module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.mongodbio.html">apache_beam.io.mongodbio module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.parquetio.html">apache_beam.io.parquetio module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.range_trackers.html">apache_beam.io.range_trackers module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.restriction_trackers.html">apache_beam.io.restriction_trackers module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.snowflake.html">apache_beam.io.snowflake module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.source_test_utils.html">apache_beam.io.source_test_utils module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.textio.html">apache_beam.io.textio module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.tfrecordio.html">apache_beam.io.tfrecordio module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.utils.html">apache_beam.io.utils module</a></li>
<li class="toctree-l3"><a class="reference internal" href="apache_beam.io.watermark_estimators.html">apache_beam.io.watermark_estimators module</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.metrics.html">apache_beam.metrics package</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.ml.html">apache_beam.ml package</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.options.html">apache_beam.options package</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.portability.html">apache_beam.portability package</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.runners.html">apache_beam.runners package</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.transforms.html">apache_beam.transforms package</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.typehints.html">apache_beam.typehints package</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.utils.html">apache_beam.utils package</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.error.html">apache_beam.error module</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.pipeline.html">apache_beam.pipeline module</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.pvalue.html">apache_beam.pvalue module</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Apache Beam</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> &raquo;</li>
<li><a href="apache_beam.io.html">apache_beam.io package</a> &raquo;</li>
<li>apache_beam.io.jdbc module</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/apache_beam.io.jdbc.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="module-apache_beam.io.jdbc">
<span id="apache-beam-io-jdbc-module"></span><h1>apache_beam.io.jdbc module<a class="headerlink" href="#module-apache_beam.io.jdbc" title="Permalink to this headline"></a></h1>
<p>PTransforms for supporting Jdbc in Python pipelines.</p>
<p>These transforms are currently supported by Beam portable
Flink, Spark, and Dataflow v2 runners.</p>
<p><strong>Setup</strong></p>
<p>Transforms provided in this module are cross-language transforms
implemented in the Beam Java SDK. During the pipeline construction, Python SDK
will connect to a Java expansion service to expand these transforms.
To facilitate this, a small amount of setup is needed before using these
transforms in a Beam Python pipeline.</p>
<p>There are several ways to setup cross-language Jdbc transforms.</p>
<ul class="simple">
<li>Option 1: use the default expansion service</li>
<li>Option 2: specify a custom expansion service</li>
</ul>
<p>See below for details regarding each of these options.</p>
<p><em>Option 1: Use the default expansion service</em></p>
<p>This is the recommended and easiest setup option for using Python Jdbc
transforms. This option is only available for Beam 2.24.0 and later.</p>
<p>This option requires following pre-requisites before running the Beam
pipeline.</p>
<ul class="simple">
<li>Install Java runtime in the computer from where the pipeline is constructed
and make sure that ‘java’ command is available.</li>
</ul>
<p>In this option, Python SDK will either download (for released Beam version) or
build (when running from a Beam Git clone) a expansion service jar and use
that to expand transforms. Currently Jdbc transforms use the
‘beam-sdks-java-io-expansion-service’ jar for this purpose.</p>
<p>The transforms in this file support an extra <cite>classpath</cite> argument, where one
can specify any extra JARs to be included in the classpath for the expansion
service. Users will need to specify this option to include the JDBC driver
for the database that you’re trying to use. <strong>By default, a Postgres JDBC
driver</strong> is included (i.e. the Java package
<cite>“org.postgresql:postgresql:42.2.16”</cite>).</p>
<p><em>Option 2: specify a custom expansion service</em></p>
<p>In this option, you startup your own expansion service and provide that as
a parameter when using the transforms provided in this module.</p>
<p>This option requires following pre-requisites before running the Beam
pipeline.</p>
<ul class="simple">
<li>Startup your own expansion service.</li>
<li>Update your pipeline to provide the expansion service address when
initiating Jdbc transforms provided in this module.</li>
</ul>
<p>Flink Users can use the built-in Expansion Service of the Flink Runner’s
Job Server. If you start Flink’s Job Server, the expansion service will be
started on port 8097. For a different address, please set the
expansion_service parameter.</p>
<p><strong>More information</strong></p>
<p>For more information regarding cross-language transforms see:
- <a class="reference external" href="https://beam.apache.org/roadmap/portability/">https://beam.apache.org/roadmap/portability/</a></p>
<p>For more information specific to Flink runner see:
- <a class="reference external" href="https://beam.apache.org/documentation/runners/flink/">https://beam.apache.org/documentation/runners/flink/</a></p>
<dl class="class">
<dt id="apache_beam.io.jdbc.WriteToJdbc">
<em class="property">class </em><code class="descclassname">apache_beam.io.jdbc.</code><code class="descname">WriteToJdbc</code><span class="sig-paren">(</span><em>table_name</em>, <em>driver_class_name</em>, <em>jdbc_url</em>, <em>username</em>, <em>password</em>, <em>statement=None</em>, <em>connection_properties=None</em>, <em>connection_init_sqls=None</em>, <em>expansion_service=None</em>, <em>classpath=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/jdbc.html#WriteToJdbc"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.jdbc.WriteToJdbc" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="apache_beam.transforms.external.html#apache_beam.transforms.external.ExternalTransform" title="apache_beam.transforms.external.ExternalTransform"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.transforms.external.ExternalTransform</span></code></a></p>
<p>A PTransform which writes Rows to the specified database via JDBC.</p>
<p>This transform receives Rows defined as NamedTuple type and registered in
the coders registry, e.g.:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ExampleRow</span> <span class="o">=</span> <span class="n">typing</span><span class="o">.</span><span class="n">NamedTuple</span><span class="p">(</span><span class="s1">&#39;ExampleRow&#39;</span><span class="p">,</span>
<span class="p">[(</span><span class="s1">&#39;id&#39;</span><span class="p">,</span> <span class="nb">int</span><span class="p">),</span> <span class="p">(</span><span class="s1">&#39;name&#39;</span><span class="p">,</span> <span class="n">unicode</span><span class="p">)])</span>
<span class="n">coders</span><span class="o">.</span><span class="n">registry</span><span class="o">.</span><span class="n">register_coder</span><span class="p">(</span><span class="n">ExampleRow</span><span class="p">,</span> <span class="n">coders</span><span class="o">.</span><span class="n">RowCoder</span><span class="p">)</span>
<span class="k">with</span> <span class="n">TestPipeline</span><span class="p">()</span> <span class="k">as</span> <span class="n">p</span><span class="p">:</span>
<span class="n">_</span> <span class="o">=</span> <span class="p">(</span>
<span class="n">p</span>
<span class="o">|</span> <span class="n">beam</span><span class="o">.</span><span class="n">Create</span><span class="p">([</span><span class="n">ExampleRow</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="s1">&#39;abc&#39;</span><span class="p">)])</span>
<span class="o">.</span><span class="n">with_output_types</span><span class="p">(</span><span class="n">ExampleRow</span><span class="p">)</span>
<span class="o">|</span> <span class="s1">&#39;Write to jdbc&#39;</span> <span class="o">&gt;&gt;</span> <span class="n">WriteToJdbc</span><span class="p">(</span>
<span class="n">table_name</span><span class="o">=</span><span class="s1">&#39;jdbc_external_test_write&#39;</span>
<span class="n">driver_class_name</span><span class="o">=</span><span class="s1">&#39;org.postgresql.Driver&#39;</span><span class="p">,</span>
<span class="n">jdbc_url</span><span class="o">=</span><span class="s1">&#39;jdbc:postgresql://localhost:5432/example&#39;</span><span class="p">,</span>
<span class="n">username</span><span class="o">=</span><span class="s1">&#39;postgres&#39;</span><span class="p">,</span>
<span class="n">password</span><span class="o">=</span><span class="s1">&#39;postgres&#39;</span><span class="p">,</span>
<span class="p">))</span>
</pre></div>
</div>
<p>table_name is a required paramater, and by default, the write_statement is
generated from it.</p>
<p>The generated write_statement can be overridden by passing in a
write_statment.</p>
<p>Experimental; no backwards compatibility guarantees.</p>
<p>Initializes a write operation to Jdbc.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>driver_class_name</strong> – name of the jdbc driver class</li>
<li><strong>jdbc_url</strong> – full jdbc url to the database.</li>
<li><strong>username</strong> – database username</li>
<li><strong>password</strong> – database password</li>
<li><strong>statement</strong> – sql statement to be executed</li>
<li><strong>connection_properties</strong> – properties of the jdbc connection
passed as string with format
[propertyName=property;]*</li>
<li><strong>connection_init_sqls</strong> – required only for MySql and MariaDB.
passed as list of strings</li>
<li><strong>expansion_service</strong> – The address (host:port) of the ExpansionService.</li>
<li><strong>classpath</strong> – A list of JARs or Java packages to include in the
classpath for the expansion service. This option is
usually needed for <cite>jdbc</cite> to include extra JDBC driver
packages.
The packages can be in these three formats: (1) A local
file, (2) A URL, (3) A gradle-style identifier of a Maven
package (e.g. “org.postgresql:postgresql:42.3.1”).
By default, this argument includes a Postgres SQL JDBC
driver.</li>
</ul>
</td>
</tr>
</tbody>
</table>
<dl class="attribute">
<dt id="apache_beam.io.jdbc.WriteToJdbc.URN">
<code class="descname">URN</code><em class="property"> = 'beam:transform:org.apache.beam:schemaio_jdbc_write:v1'</em><a class="headerlink" href="#apache_beam.io.jdbc.WriteToJdbc.URN" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="apache_beam.io.jdbc.ReadFromJdbc">
<em class="property">class </em><code class="descclassname">apache_beam.io.jdbc.</code><code class="descname">ReadFromJdbc</code><span class="sig-paren">(</span><em>table_name</em>, <em>driver_class_name</em>, <em>jdbc_url</em>, <em>username</em>, <em>password</em>, <em>query=None</em>, <em>output_parallelization=None</em>, <em>fetch_size=None</em>, <em>connection_properties=None</em>, <em>connection_init_sqls=None</em>, <em>expansion_service=None</em>, <em>classpath=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/jdbc.html#ReadFromJdbc"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.jdbc.ReadFromJdbc" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="apache_beam.transforms.external.html#apache_beam.transforms.external.ExternalTransform" title="apache_beam.transforms.external.ExternalTransform"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.transforms.external.ExternalTransform</span></code></a></p>
<p>A PTransform which reads Rows from the specified database via JDBC.</p>
<p>This transform delivers Rows defined as NamedTuple registered in
the coders registry, e.g.:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ExampleRow</span> <span class="o">=</span> <span class="n">typing</span><span class="o">.</span><span class="n">NamedTuple</span><span class="p">(</span><span class="s1">&#39;ExampleRow&#39;</span><span class="p">,</span>
<span class="p">[(</span><span class="s1">&#39;id&#39;</span><span class="p">,</span> <span class="nb">int</span><span class="p">),</span> <span class="p">(</span><span class="s1">&#39;name&#39;</span><span class="p">,</span> <span class="n">unicode</span><span class="p">)])</span>
<span class="n">coders</span><span class="o">.</span><span class="n">registry</span><span class="o">.</span><span class="n">register_coder</span><span class="p">(</span><span class="n">ExampleRow</span><span class="p">,</span> <span class="n">coders</span><span class="o">.</span><span class="n">RowCoder</span><span class="p">)</span>
<span class="k">with</span> <span class="n">TestPipeline</span><span class="p">()</span> <span class="k">as</span> <span class="n">p</span><span class="p">:</span>
<span class="n">result</span> <span class="o">=</span> <span class="p">(</span>
<span class="n">p</span>
<span class="o">|</span> <span class="s1">&#39;Read from jdbc&#39;</span> <span class="o">&gt;&gt;</span> <span class="n">ReadFromJdbc</span><span class="p">(</span>
<span class="n">table_name</span><span class="o">=</span><span class="s1">&#39;jdbc_external_test_read&#39;</span>
<span class="n">driver_class_name</span><span class="o">=</span><span class="s1">&#39;org.postgresql.Driver&#39;</span><span class="p">,</span>
<span class="n">jdbc_url</span><span class="o">=</span><span class="s1">&#39;jdbc:postgresql://localhost:5432/example&#39;</span><span class="p">,</span>
<span class="n">username</span><span class="o">=</span><span class="s1">&#39;postgres&#39;</span><span class="p">,</span>
<span class="n">password</span><span class="o">=</span><span class="s1">&#39;postgres&#39;</span><span class="p">,</span>
<span class="p">))</span>
</pre></div>
</div>
<p>table_name is a required paramater, and by default, the read_query is
generated from it.</p>
<p>The generated read_query can be overridden by passing in a read_query.</p>
<p>Experimental; no backwards compatibility guarantees.</p>
<p>Initializes a read operation from Jdbc.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>driver_class_name</strong> – name of the jdbc driver class</li>
<li><strong>jdbc_url</strong> – full jdbc url to the database.</li>
<li><strong>username</strong> – database username</li>
<li><strong>password</strong> – database password</li>
<li><strong>query</strong> – sql query to be executed</li>
<li><strong>output_parallelization</strong> – is output parallelization on</li>
<li><strong>fetch_size</strong> – how many rows to fetch</li>
<li><strong>connection_properties</strong> – properties of the jdbc connection
passed as string with format
[propertyName=property;]*</li>
<li><strong>connection_init_sqls</strong> – required only for MySql and MariaDB.
passed as list of strings</li>
<li><strong>expansion_service</strong> – The address (host:port) of the ExpansionService.</li>
<li><strong>classpath</strong> – A list of JARs or Java packages to include in the
classpath for the expansion service. This option is
usually needed for <cite>jdbc</cite> to include extra JDBC driver
packages.
The packages can be in these three formats: (1) A local
file, (2) A URL, (3) A gradle-style identifier of a Maven
package (e.g. “org.postgresql:postgresql:42.3.1”).
By default, this argument includes a Postgres SQL JDBC
driver.</li>
</ul>
</td>
</tr>
</tbody>
</table>
<dl class="attribute">
<dt id="apache_beam.io.jdbc.ReadFromJdbc.URN">
<code class="descname">URN</code><em class="property"> = 'beam:transform:org.apache.beam:schemaio_jdbc_read:v1'</em><a class="headerlink" href="#apache_beam.io.jdbc.ReadFromJdbc.URN" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="apache_beam.io.kafka.html" class="btn btn-neutral float-right" title="apache_beam.io.kafka module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="apache_beam.io.iobase.html" class="btn btn-neutral float-left" title="apache_beam.io.iobase module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>