| |
| |
| <!DOCTYPE html> |
| <html class="writer-html5" lang="en" data-content_root="./"> |
| <head> |
| <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" /> |
| |
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |
| <title>apache_beam.io.jdbc module — Apache Beam 2.67.0 documentation</title> |
| <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" /> |
| <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" /> |
| |
| |
| <script src="_static/jquery.js?v=5d32c60e"></script> |
| <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> |
| <script src="_static/documentation_options.js?v=959b4fbe"></script> |
| <script src="_static/doctools.js?v=9a2dae69"></script> |
| <script src="_static/sphinx_highlight.js?v=dc90522c"></script> |
| <script src="_static/js/theme.js"></script> |
| <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 role="search"> |
| <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> |
| <input type="text" name="q" placeholder="Search docs" aria-label="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="Navigation menu"> |
| <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><ul> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.io.jdbc.WriteToJdbc"><code class="docutils literal notranslate"><span class="pre">WriteToJdbc</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.io.jdbc.ReadFromJdbc"><code class="docutils literal notranslate"><span class="pre">ReadFromJdbc</span></code></a></li> |
| </ul> |
| </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.requestresponse.html">apache_beam.io.requestresponse 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.testing.html">apache_beam.testing 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> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.yaml.html">apache_beam.yaml 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="Mobile navigation menu" > |
| <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="Page navigation"> |
| <ul class="wy-breadcrumbs"> |
| <li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li> |
| <li class="breadcrumb-item"><a href="apache_beam.io.html">apache_beam.io package</a></li> |
| <li class="breadcrumb-item active">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"> |
| |
| <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="Link to this heading"></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><p>Option 1: use the default expansion service</p></li> |
| <li><p>Option 2: specify a custom expansion service</p></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><p>Install Java runtime in the computer from where the pipeline is constructed |
| and make sure that ‘java’ command is available.</p></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><p>Startup your own expansion service.</p></li> |
| <li><p>Update your pipeline to provide the expansion service address when |
| initiating Jdbc transforms provided in this module.</p></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="py class"> |
| <dt class="sig sig-object py" id="apache_beam.io.jdbc.WriteToJdbc"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.io.jdbc.</span></span><span class="sig-name descname"><span class="pre">WriteToJdbc</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">table_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">driver_class_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">jdbc_url</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">username</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">password</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">statement</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">connection_properties</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">connection_init_sqls</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">autosharding</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_connections</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">driver_jars</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">expansion_service</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">classpath</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">write_batch_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/jdbc.html#WriteToJdbc"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.io.jdbc.WriteToJdbc" title="Link 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">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">'ExampleRow'</span><span class="p">,</span> |
| <span class="p">[(</span><span class="s1">'id'</span><span class="p">,</span> <span class="nb">int</span><span class="p">),</span> <span class="p">(</span><span class="s1">'name'</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">'abc'</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">'Write to jdbc'</span> <span class="o">>></span> <span class="n">WriteToJdbc</span><span class="p">(</span> |
| <span class="n">table_name</span><span class="o">=</span><span class="s1">'jdbc_external_test_write'</span> |
| <span class="n">driver_class_name</span><span class="o">=</span><span class="s1">'org.postgresql.Driver'</span><span class="p">,</span> |
| <span class="n">jdbc_url</span><span class="o">=</span><span class="s1">'jdbc:postgresql://localhost:5432/example'</span><span class="p">,</span> |
| <span class="n">username</span><span class="o">=</span><span class="s1">'postgres'</span><span class="p">,</span> |
| <span class="n">password</span><span class="o">=</span><span class="s1">'postgres'</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> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>driver_class_name</strong> – name of the jdbc driver class</p></li> |
| <li><p><strong>jdbc_url</strong> – full jdbc url to the database.</p></li> |
| <li><p><strong>username</strong> – database username</p></li> |
| <li><p><strong>password</strong> – database password</p></li> |
| <li><p><strong>statement</strong> – sql statement to be executed</p></li> |
| <li><p><strong>connection_properties</strong> – properties of the jdbc connection |
| passed as string with format |
| [propertyName=property;]*</p></li> |
| <li><p><strong>connection_init_sqls</strong> – required only for MySql and MariaDB. |
| passed as list of strings</p></li> |
| <li><p><strong>autosharding</strong> – enable automatic re-sharding of bundles to scale the |
| number of shards with the number of workers.</p></li> |
| <li><p><strong>max_connections</strong> – sets the maximum total number of connections. |
| use a negative value for no limit.</p></li> |
| <li><p><strong>driver_jars</strong> – comma separated paths for JDBC drivers. if not |
| specified, the default classloader is used to load the |
| driver jars.</p></li> |
| <li><p><strong>expansion_service</strong> – The address (host:port) of the ExpansionService.</p></li> |
| <li><p><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.</p></li> |
| <li><p><strong>write_batch_size</strong> – sets the maximum size in number of SQL statement |
| for the batch. |
| default is <a class="reference external" href="mailto:{%40link">{<span>@</span>link</a> JdbcIO.DEFAULT_BATCH_SIZE}</p></li> |
| </ul> |
| </dd> |
| </dl> |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.io.jdbc.WriteToJdbc.URN"> |
| <span class="sig-name descname"><span class="pre">URN</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'beam:transform:org.apache.beam:schemaio_jdbc_write:v1'</span></em><a class="headerlink" href="#apache_beam.io.jdbc.WriteToJdbc.URN" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.io.jdbc.ReadFromJdbc"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.io.jdbc.</span></span><span class="sig-name descname"><span class="pre">ReadFromJdbc</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">table_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">driver_class_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">jdbc_url</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">username</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">password</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">query</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">disable_autocommit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_parallelization</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fetch_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">partition_column</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">partitions</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">connection_properties</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">connection_init_sqls</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_connections</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">driver_jars</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">expansion_service</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">classpath</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">schema</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/jdbc.html#ReadFromJdbc"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.io.jdbc.ReadFromJdbc" title="Link 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">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">'ExampleRow'</span><span class="p">,</span> |
| <span class="p">[(</span><span class="s1">'id'</span><span class="p">,</span> <span class="nb">int</span><span class="p">),</span> <span class="p">(</span><span class="s1">'name'</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">'Read from jdbc'</span> <span class="o">>></span> <span class="n">ReadFromJdbc</span><span class="p">(</span> |
| <span class="n">table_name</span><span class="o">=</span><span class="s1">'jdbc_external_test_read'</span> |
| <span class="n">driver_class_name</span><span class="o">=</span><span class="s1">'org.postgresql.Driver'</span><span class="p">,</span> |
| <span class="n">jdbc_url</span><span class="o">=</span><span class="s1">'jdbc:postgresql://localhost:5432/example'</span><span class="p">,</span> |
| <span class="n">username</span><span class="o">=</span><span class="s1">'postgres'</span><span class="p">,</span> |
| <span class="n">password</span><span class="o">=</span><span class="s1">'postgres'</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> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>driver_class_name</strong> – name of the jdbc driver class</p></li> |
| <li><p><strong>jdbc_url</strong> – full jdbc url to the database.</p></li> |
| <li><p><strong>username</strong> – database username</p></li> |
| <li><p><strong>password</strong> – database password</p></li> |
| <li><p><strong>query</strong> – sql query to be executed</p></li> |
| <li><p><strong>disable_autocommit</strong> – disable autocommit on read</p></li> |
| <li><p><strong>output_parallelization</strong> – is output parallelization on</p></li> |
| <li><p><strong>fetch_size</strong> – how many rows to fetch</p></li> |
| <li><p><strong>partition_column</strong> – enable partitioned reads by splitting on this |
| column</p></li> |
| <li><p><strong>partitions</strong> – override the default number of splits when using |
| partition_column</p></li> |
| <li><p><strong>connection_properties</strong> – properties of the jdbc connection |
| passed as string with format |
| [propertyName=property;]*</p></li> |
| <li><p><strong>connection_init_sqls</strong> – required only for MySql and MariaDB. |
| passed as list of strings</p></li> |
| <li><p><strong>max_connections</strong> – sets the maximum total number of connections. |
| use a negative value for no limit.</p></li> |
| <li><p><strong>driver_jars</strong> – comma separated paths for JDBC drivers. if not |
| specified, the default classloader is used to load the |
| driver jars.</p></li> |
| <li><p><strong>expansion_service</strong> – The address (host:port) of the ExpansionService.</p></li> |
| <li><p><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.</p></li> |
| <li><p><strong>schema</strong> – Optional custom schema for the returned rows. If provided, |
| this should be a NamedTuple type that defines the structure |
| of the output PCollection elements. This bypasses automatic |
| schema inference during pipeline construction.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.io.jdbc.ReadFromJdbc.URN"> |
| <span class="sig-name descname"><span class="pre">URN</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'beam:transform:org.apache.beam:schemaio_jdbc_read:v1'</span></em><a class="headerlink" href="#apache_beam.io.jdbc.ReadFromJdbc.URN" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| </section> |
| |
| |
| </div> |
| </div> |
| <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> |
| <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" aria-hidden="true"></span> Previous</a> |
| <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" aria-hidden="true"></span></a> |
| </div> |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p>© Copyright %Y, Apache Beam.</p> |
| </div> |
| |
| Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a |
| <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> |
| provided by <a href="https://readthedocs.org">Read the Docs</a>. |
| |
| |
| </footer> |
| </div> |
| </div> |
| </section> |
| </div> |
| <script> |
| jQuery(function () { |
| SphinxRtdTheme.Navigation.enable(true); |
| }); |
| </script> |
| |
| </body> |
| </html> |
