forked from docs/doc-exports
Su, Xiaomeng
04d4597cf3
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com> Co-authored-by: Su, Xiaomeng <suxiaomeng1@huawei.com> Co-committed-by: Su, Xiaomeng <suxiaomeng1@huawei.com>
146 lines
16 KiB
HTML
146 lines
16 KiB
HTML
<a name="dli_08_0303"></a><a name="dli_08_0303"></a>
|
|
|
|
<h1 class="topictitle1">JDBC Source Table</h1>
|
|
<div id="body8662426"><div class="section" id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_section11554812174420"><h4 class="sectiontitle">Function</h4><p id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_dli_08_0270_p7254192618812">The JDBC connector is a Flink's built-in connector to read data from a database.</p>
|
|
</div>
|
|
<div class="section" id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_section0641438122515"><h4 class="sectiontitle">Prerequisites</h4><ul id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_ul036513387289"><li id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_li036513816282">An enhanced datasource connection with the database has been established, so that you can configure security group rules as required.</li></ul>
|
|
</div>
|
|
<div class="section" id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_section055264284416"><h4 class="sectiontitle">Syntax</h4><pre class="screen" id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_screen143570576440">create table jbdcSource (
|
|
attr_name attr_type
|
|
(',' attr_name attr_type)*
|
|
(','PRIMARY KEY (attr_name, ...) NOT ENFORCED)
|
|
(',' watermark for rowtime_column_name as watermark-strategy_expression)
|
|
)
|
|
with (
|
|
'connector.type' = 'jdbc',
|
|
'connector.url' = '',
|
|
'connector.table' = '',
|
|
'connector.username' = '',
|
|
'connector.password' = ''
|
|
);</pre>
|
|
</div>
|
|
<div class="section" id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_section1918619215263"><h4 class="sectiontitle">Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_table3535131492817" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_row053518147287"><th align="left" class="cellrowborder" valign="top" width="28.93289328932893%" id="mcps1.3.4.2.2.4.1.1"><p id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_p153513145285">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="7.500750075007501%" id="mcps1.3.4.2.2.4.1.2"><p id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_p10535014202815">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="63.56635663566357%" id="mcps1.3.4.2.2.4.1.3"><p id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_p19535151482813">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_row653531413287"><td class="cellrowborder" valign="top" width="28.93289328932893%" headers="mcps1.3.4.2.2.4.1.1 "><p id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_p16535121422812">connector.type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="7.500750075007501%" headers="mcps1.3.4.2.2.4.1.2 "><p id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_p5535141410287">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.56635663566357%" headers="mcps1.3.4.2.2.4.1.3 "><p id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_p5535114162811">Data source type. Set this parameter to <strong id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_b1810419541425">jdbc</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_row65351614172820"><td class="cellrowborder" valign="top" width="28.93289328932893%" headers="mcps1.3.4.2.2.4.1.1 "><p id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_p15535141432819">connector.url</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="7.500750075007501%" headers="mcps1.3.4.2.2.4.1.2 "><p id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_p1653517144282">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.56635663566357%" headers="mcps1.3.4.2.2.4.1.3 "><p id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_p12535914122818">Database URL</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_row11535151410283"><td class="cellrowborder" valign="top" width="28.93289328932893%" headers="mcps1.3.4.2.2.4.1.1 "><p id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_p17535131482814">connector.table</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="7.500750075007501%" headers="mcps1.3.4.2.2.4.1.2 "><p id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_p653621414283">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.56635663566357%" headers="mcps1.3.4.2.2.4.1.3 "><p id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_p2536191418289">Name of the table where the data to be read from the database is located</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_row753618145283"><td class="cellrowborder" valign="top" width="28.93289328932893%" headers="mcps1.3.4.2.2.4.1.1 "><p id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_p95361214202815">connector.driver</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="7.500750075007501%" headers="mcps1.3.4.2.2.4.1.2 "><p id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_p1353613148281">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.56635663566357%" headers="mcps1.3.4.2.2.4.1.3 "><p id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_p1453631462817">Driver required for connecting to the database If you do not set this parameter, the automatically extracted URL will be used.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_row195361114142812"><td class="cellrowborder" valign="top" width="28.93289328932893%" headers="mcps1.3.4.2.2.4.1.1 "><p id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_p105364142285">connector.username</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="7.500750075007501%" headers="mcps1.3.4.2.2.4.1.2 "><p id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_p1128519229372">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.56635663566357%" headers="mcps1.3.4.2.2.4.1.3 "><p id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_p175361714162814">Database authentication username. This parameter must be configured in pair with <strong id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_b6590142713715">connector.password</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_row553641414283"><td class="cellrowborder" valign="top" width="28.93289328932893%" headers="mcps1.3.4.2.2.4.1.1 "><p id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_p6536614122819">connector.password</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="7.500750075007501%" headers="mcps1.3.4.2.2.4.1.2 "><p id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_p6536131442814">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.56635663566357%" headers="mcps1.3.4.2.2.4.1.3 "><p id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_p953641462814">Database authentication password. This parameter must be configured in pair with <strong id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_b1461131113518">connector.username</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_row4536171416283"><td class="cellrowborder" valign="top" width="28.93289328932893%" headers="mcps1.3.4.2.2.4.1.1 "><p id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_p145360147285">connector.read.partition.column</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="7.500750075007501%" headers="mcps1.3.4.2.2.4.1.2 "><p id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_p2053671411284">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.56635663566357%" headers="mcps1.3.4.2.2.4.1.3 "><p id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_p116589384217">Name of the column used to partition the input</p>
|
|
<p id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_p10221143134012"></p>
|
|
<p id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_p553619143288">This parameter is mandatory if<strong id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_b1483819113384"> connector.read.partition.lower-bound</strong>, <strong id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_b74971603812">connector.read.partition.upper-bound</strong>, and</p>
|
|
<p id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_p122355233618"><strong id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_b516181113814">connector.read.partition.num</strong> are configured.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_row553651415284"><td class="cellrowborder" valign="top" width="28.93289328932893%" headers="mcps1.3.4.2.2.4.1.1 "><p id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_p13536121417280">connector.read.partition.lower-bound</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="7.500750075007501%" headers="mcps1.3.4.2.2.4.1.2 "><p id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_p12536141432814">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.56635663566357%" headers="mcps1.3.4.2.2.4.1.3 "><p id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_p288018561266">Lower bound of values to be fetched for the first partition</p>
|
|
<p id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_p1959201591213">This parameter is mandatory if <strong id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_b88221034115020">connector.read.partition.column</strong>, <strong id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_b14592193814503">connector.read.partition.upper-bound</strong>, and</p>
|
|
<p id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_p45961516127"><strong id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_b58911948145018">connector.read.partition.num</strong> are configured.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_row1453617144288"><td class="cellrowborder" valign="top" width="28.93289328932893%" headers="mcps1.3.4.2.2.4.1.1 "><p id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_p1536111412282">connector.read.partition.upper-bound</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="7.500750075007501%" headers="mcps1.3.4.2.2.4.1.2 "><p id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_p19536114202818">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.56635663566357%" headers="mcps1.3.4.2.2.4.1.3 "><p id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_p121666952715">Upper bound of values to be fetched for the last partition</p>
|
|
<p id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_p1817519503128">This parameter is mandatory if <strong id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_b20799163020522">connector.read.partition.column</strong>, <strong id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_b84753518520">connector.read.partition.lower-bound</strong>, and</p>
|
|
<p id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_p20175125017128"><strong id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_b36571240155217">connector.read.partition.num</strong> are configured.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_row10536131422818"><td class="cellrowborder" valign="top" width="28.93289328932893%" headers="mcps1.3.4.2.2.4.1.1 "><p id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_p05361514192815">connector.read.partition.num</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="7.500750075007501%" headers="mcps1.3.4.2.2.4.1.2 "><p id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_p353615142286">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.56635663566357%" headers="mcps1.3.4.2.2.4.1.3 "><p id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_p169219816221">Number of partitions to be created</p>
|
|
<p id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_p109633922216"></p>
|
|
<p id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_p91551751111210">This parameter is mandatory if <strong id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_b15937122313535">connector.read.partition.column</strong>, <strong id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_b15918192895320">connector.read.partition.upper-bound</strong>, and </p>
|
|
<p id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_p1155115101214"><strong id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_b278133165312">connector.read.partition.upper-bound</strong> are configured.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_row35365143283"><td class="cellrowborder" valign="top" width="28.93289328932893%" headers="mcps1.3.4.2.2.4.1.1 "><p id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_p13536161420286">connector.read.fetch-size</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="7.500750075007501%" headers="mcps1.3.4.2.2.4.1.2 "><p id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_p153631417288">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.56635663566357%" headers="mcps1.3.4.2.2.4.1.3 "><p id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_p726673414232">Number of rows fetched from the database each time The default value is <strong id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_b1697120131018">0</strong>, indicating the hint is ignored.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_section179081525174"><h4 class="sectiontitle">Precautions</h4><p id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_p43398711189">None</p>
|
|
</div>
|
|
<div class="section" id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_section163901016188"><h4 class="sectiontitle">Example</h4><pre class="screen" id="dli_08_0303__en-us_topic_0000001119072192_en-us_topic_0000001128238657_screen817162382018">create table jdbcSource (
|
|
car_id STRING,
|
|
car_owner STRING,
|
|
car_age INT,
|
|
average_speed INT,
|
|
total_miles INT)
|
|
with (
|
|
'connector.type' = 'jdbc',
|
|
'connector.url' = 'jdbc:mysql://xx.xx.xx.xx:3306/xx',
|
|
'connector.table' = 'jdbc_table_name',
|
|
'connector.driver' = 'com.mysql.jdbc.Driver',
|
|
'connector.username' = 'xxx',
|
|
'connector.password' = 'xxxxxx'
|
|
);</pre>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="dli_08_0300.html">Creating a Source Table</a></div>
|
|
</div>
|
|
</div>
|
|
|