doc-exports/docs/dataartsstudio/api-ref/dataartsstudio_02_0282.html
Xiong, Chen Xiao 14a6d65e8c DataArts API 20240130 version
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com>
Co-authored-by: Xiong, Chen Xiao <chenxiaoxiong@huawei.com>
Co-committed-by: Xiong, Chen Xiao <chenxiaoxiong@huawei.com>
2024-03-01 11:46:15 +00:00

143 lines
15 KiB
HTML

<a name="dataartsstudio_02_0282"></a><a name="dataartsstudio_02_0282"></a>
<h1 class="topictitle1">From a Relational Database</h1>
<div id="body8662426"><div class="section" id="dataartsstudio_02_0282__en-us_topic_0108272803_section33401108172339"><h4 class="sectiontitle">Sample JSON File</h4><pre class="screen" id="dataartsstudio_02_0282__en-us_topic_0108272803_screen43360057172459">"from-config-values": {
"configs": [
{
"inputs": [
{
"name": "fromJobConfig.useSql",
"value": "false"
},
{
"name": "fromJobConfig.schemaName",
"value": "rf_database"
},
{
"name": "fromJobConfig.tableName",
"value": "rf_from"
},
{
"name": "fromJobConfig.columnList",
"value": "AA&amp;BB"
},
{
"name": "fromJobConfig.incrMigration",
"value": "false"
}
],
"name": "fromJobConfig"
}
]
}</pre>
</div>
<div class="section" id="dataartsstudio_02_0282__en-us_topic_0108272803_section43796280172354"><h4 class="sectiontitle">Parameter Description</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0282__en-us_topic_0108272803_table13922888141527" frame="border" border="1" rules="all"><thead align="left"><tr id="dataartsstudio_02_0282__en-us_topic_0108272803_row229143141527"><th align="left" class="cellrowborder" valign="top" width="22.66%" id="mcps1.3.2.2.1.5.1.1"><p id="dataartsstudio_02_0282__en-us_topic_0108272803_p66756185141527">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.97%" id="mcps1.3.2.2.1.5.1.2"><p id="dataartsstudio_02_0282__en-us_topic_0108272803_p38541938141527">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.669999999999998%" id="mcps1.3.2.2.1.5.1.3"><p id="dataartsstudio_02_0282__en-us_topic_0108272803_p34889279141527">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40.699999999999996%" id="mcps1.3.2.2.1.5.1.4"><p id="dataartsstudio_02_0282__en-us_topic_0108272803_p7459369141527">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dataartsstudio_02_0282__en-us_topic_0108272803_row1776305513015"><td class="cellrowborder" valign="top" width="22.66%" headers="mcps1.3.2.2.1.5.1.1 "><p id="dataartsstudio_02_0282__en-us_topic_0108272803_p11763555106">fromJobConfig.useSql</p>
</td>
<td class="cellrowborder" valign="top" width="19.97%" headers="mcps1.3.2.2.1.5.1.2 "><p id="dataartsstudio_02_0282__en-us_topic_0108272803_p197631055507">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16.669999999999998%" headers="mcps1.3.2.2.1.5.1.3 "><p id="dataartsstudio_02_0282__en-us_topic_0108272803_p31073316114">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="40.699999999999996%" headers="mcps1.3.2.2.1.5.1.4 "><p id="dataartsstudio_02_0282__en-us_topic_0108272803_p27637553017">Whether to use the customized SQL statement to export data when exporting relational database data</p>
</td>
</tr>
<tr id="dataartsstudio_02_0282__en-us_topic_0108272803_row108882015116"><td class="cellrowborder" valign="top" width="22.66%" headers="mcps1.3.2.2.1.5.1.1 "><p id="dataartsstudio_02_0282__en-us_topic_0108272803_p158881014112">fromJobConfig.sql</p>
</td>
<td class="cellrowborder" valign="top" width="19.97%" headers="mcps1.3.2.2.1.5.1.2 "><p id="dataartsstudio_02_0282__en-us_topic_0108272803_p11888705116">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.669999999999998%" headers="mcps1.3.2.2.1.5.1.3 "><p id="dataartsstudio_02_0282__en-us_topic_0108272803_p179352342119">String</p>
</td>
<td class="cellrowborder" valign="top" width="40.699999999999996%" headers="mcps1.3.2.2.1.5.1.4 "><p id="dataartsstudio_02_0282__en-us_topic_0108272803_p5220739135">Customized SQL statement. CDM executes the SQL statement to export data.</p>
</td>
</tr>
<tr id="dataartsstudio_02_0282__en-us_topic_0108272803_row62628929141527"><td class="cellrowborder" valign="top" width="22.66%" headers="mcps1.3.2.2.1.5.1.1 "><p id="dataartsstudio_02_0282__en-us_topic_0108272803_p18560626141527">fromJobConfig.schemaName</p>
</td>
<td class="cellrowborder" valign="top" width="19.97%" headers="mcps1.3.2.2.1.5.1.2 "><p id="dataartsstudio_02_0282__en-us_topic_0108272803_p27015713141527">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16.669999999999998%" headers="mcps1.3.2.2.1.5.1.3 "><p id="dataartsstudio_02_0282__en-us_topic_0108272803_p50167516142856">String</p>
</td>
<td class="cellrowborder" valign="top" width="40.699999999999996%" headers="mcps1.3.2.2.1.5.1.4 "><p id="dataartsstudio_02_0282__en-us_topic_0108272803_p2430205141527">Database mode or tablespace. For example, <span class="parmvalue" id="dataartsstudio_02_0282__en-us_topic_0108272803_parmvalue1468552513113418"><b>public</b></span>.</p>
<div class="note" id="dataartsstudio_02_0282__en-us_topic_0108272803_note1969303595314"><span class="notetitle"> NOTE: </span><div class="notebody"><div class="p" id="dataartsstudio_02_0282__en-us_topic_0108272803_en-us_topic_0108275324_p57768350415">The parameter value can contain wildcard characters (*), which is used to export all databases whose names start with a certain prefix or end with a certain suffix. The examples are as follows:<ul id="dataartsstudio_02_0282__en-us_topic_0108272803_en-us_topic_0108275324_ul15884133718419"><li id="dataartsstudio_02_0282__en-us_topic_0108272803_en-us_topic_0108275324_li288413724113"><strong id="dataartsstudio_02_0282__en-us_topic_0108272803_en-us_topic_0108275324_b769453513530">SCHEMA*</strong> indicates that all databases whose names starting with <span class="uicontrol" id="dataartsstudio_02_0282__en-us_topic_0108272803_en-us_topic_0108275324_uicontrol32392238485"><b>SCHEMA</b></span> are exported.</li><li id="dataartsstudio_02_0282__en-us_topic_0108272803_en-us_topic_0108275324_li18411188471"><strong id="dataartsstudio_02_0282__en-us_topic_0108272803_en-us_topic_0108275324_b3571824719">*SCHEMA</strong> indicates that all databases whose names ending with <span class="uicontrol" id="dataartsstudio_02_0282__en-us_topic_0108272803_en-us_topic_0108275324_uicontrol713716279482"><b>SCHEMA</b></span> are exported.</li><li id="dataartsstudio_02_0282__en-us_topic_0108272803_en-us_topic_0108275324_li977133418483"><strong id="dataartsstudio_02_0282__en-us_topic_0108272803_en-us_topic_0108275324_b1477283416486">*SCHEMA</strong><strong id="dataartsstudio_02_0282__en-us_topic_0108272803_en-us_topic_0108275324_b131119421488">*</strong> indicates that all databases whose names containing <span class="uicontrol" id="dataartsstudio_02_0282__en-us_topic_0108272803_en-us_topic_0108275324_uicontrol8851024195110"><b>SCHEMA</b></span> are exported.</li></ul>
</div>
</div></div>
</td>
</tr>
<tr id="dataartsstudio_02_0282__en-us_topic_0108272803_row42094113141527"><td class="cellrowborder" valign="top" width="22.66%" headers="mcps1.3.2.2.1.5.1.1 "><p id="dataartsstudio_02_0282__en-us_topic_0108272803_p26789449141527">fromJobConfig.tableName</p>
</td>
<td class="cellrowborder" valign="top" width="19.97%" headers="mcps1.3.2.2.1.5.1.2 "><p id="dataartsstudio_02_0282__en-us_topic_0108272803_p22461756141527">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16.669999999999998%" headers="mcps1.3.2.2.1.5.1.3 "><p id="dataartsstudio_02_0282__en-us_topic_0108272803_p7462956141527">String</p>
</td>
<td class="cellrowborder" valign="top" width="40.699999999999996%" headers="mcps1.3.2.2.1.5.1.4 "><p id="dataartsstudio_02_0282__en-us_topic_0108272803_p5510162412311">Table name. For example, <span class="parmvalue" id="dataartsstudio_02_0282__en-us_topic_0108272803_parmvalue413408633113439"><b>TBL_EXAMPLE</b></span>.</p>
<div class="note" id="dataartsstudio_02_0282__en-us_topic_0108272803_note5966122551119"><span class="notetitle"> NOTE: </span><div class="notebody"><div class="p" id="dataartsstudio_02_0282__en-us_topic_0108272803_en-us_topic_0108275324_p2522183912523">The table name can contain wildcard characters (*), which is used to export all tables whose names start with a certain prefix or end with a certain suffix. The number and types of fields in the tables must be the same. The examples are as follows:<ul id="dataartsstudio_02_0282__en-us_topic_0108272803_en-us_topic_0108275324_ul12793194217522"><li id="dataartsstudio_02_0282__en-us_topic_0108272803_en-us_topic_0108275324_li2079344215522"><strong id="dataartsstudio_02_0282__en-us_topic_0108272803_en-us_topic_0108275324_b9764102344710">table*</strong> indicates that all tables whose names starting with <span class="uicontrol" id="dataartsstudio_02_0282__en-us_topic_0108272803_en-us_topic_0108275324_uicontrol5206217536"><b>table</b></span> are exported.</li><li id="dataartsstudio_02_0282__en-us_topic_0108272803_en-us_topic_0108275324_li7991290534"><strong id="dataartsstudio_02_0282__en-us_topic_0108272803_en-us_topic_0108275324_b11991169185314">*table</strong> indicates that all tables whose names ending with <span class="uicontrol" id="dataartsstudio_02_0282__en-us_topic_0108272803_en-us_topic_0108275324_uicontrol16951252175715"><b>table</b></span> are exported.</li><li id="dataartsstudio_02_0282__en-us_topic_0108272803_en-us_topic_0108275324_li1999159155314"><strong id="dataartsstudio_02_0282__en-us_topic_0108272803_en-us_topic_0108275324_b5991189165316">*table</strong><strong id="dataartsstudio_02_0282__en-us_topic_0108272803_en-us_topic_0108275324_b3991209185319">*</strong> indicates that all tables whose names containing <span class="uicontrol" id="dataartsstudio_02_0282__en-us_topic_0108272803_en-us_topic_0108275324_uicontrol221153614538"><b>table</b></span> are exported.</li></ul>
</div>
</div></div>
</td>
</tr>
<tr id="dataartsstudio_02_0282__en-us_topic_0108272803_row48037190141527"><td class="cellrowborder" valign="top" width="22.66%" headers="mcps1.3.2.2.1.5.1.1 "><p id="dataartsstudio_02_0282__en-us_topic_0108272803_p43302697141527">fromJobConfig.whereClause</p>
</td>
<td class="cellrowborder" valign="top" width="19.97%" headers="mcps1.3.2.2.1.5.1.2 "><p id="dataartsstudio_02_0282__en-us_topic_0108272803_p17857575141527">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.669999999999998%" headers="mcps1.3.2.2.1.5.1.3 "><p id="dataartsstudio_02_0282__en-us_topic_0108272803_p37177510141527">String</p>
</td>
<td class="cellrowborder" valign="top" width="40.699999999999996%" headers="mcps1.3.2.2.1.5.1.4 "><p id="dataartsstudio_02_0282__en-us_topic_0108272803_p4494187612250">WHERE clause used to specify the data to be extracted. If no WHERE clause is configured, the entire table will be extracted. For example, <span class="parmvalue" id="dataartsstudio_02_0282__en-us_topic_0108272803_parmvalue1032376779113548"><b>age &gt; 18 and age &lt;= 60</b></span>.</p>
</td>
</tr>
<tr id="dataartsstudio_02_0282__en-us_topic_0108272803_row8336449141527"><td class="cellrowborder" valign="top" width="22.66%" headers="mcps1.3.2.2.1.5.1.1 "><p id="dataartsstudio_02_0282__en-us_topic_0108272803_p29681527141527">fromJobConfig.columnList</p>
</td>
<td class="cellrowborder" valign="top" width="19.97%" headers="mcps1.3.2.2.1.5.1.2 "><p id="dataartsstudio_02_0282__en-us_topic_0108272803_p55393515141527">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.669999999999998%" headers="mcps1.3.2.2.1.5.1.3 "><p id="dataartsstudio_02_0282__en-us_topic_0108272803_p57689731141527">String</p>
</td>
<td class="cellrowborder" valign="top" width="40.699999999999996%" headers="mcps1.3.2.2.1.5.1.4 "><p id="dataartsstudio_02_0282__en-us_topic_0108272803_p42356648141527">List of fields to be extracted. Use <span class="parmvalue" id="dataartsstudio_02_0282__en-us_topic_0108272803_parmvalue361045875114827"><b>&amp;</b></span> to separate field names. For example, <span class="parmvalue" id="dataartsstudio_02_0282__en-us_topic_0108272803_parmvalue1597360760113647"><b>id&amp;gid&amp;name</b></span>.</p>
</td>
</tr>
<tr id="dataartsstudio_02_0282__en-us_topic_0108272803_row9719659141527"><td class="cellrowborder" valign="top" width="22.66%" headers="mcps1.3.2.2.1.5.1.1 "><p id="dataartsstudio_02_0282__en-us_topic_0108272803_p7919181141527">fromJobConfig.partitionColumn</p>
</td>
<td class="cellrowborder" valign="top" width="19.97%" headers="mcps1.3.2.2.1.5.1.2 "><p id="dataartsstudio_02_0282__en-us_topic_0108272803_p37473904141527">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.669999999999998%" headers="mcps1.3.2.2.1.5.1.3 "><p id="dataartsstudio_02_0282__en-us_topic_0108272803_p15487355141527">String</p>
</td>
<td class="cellrowborder" valign="top" width="40.699999999999996%" headers="mcps1.3.2.2.1.5.1.4 "><p id="dataartsstudio_02_0282__en-us_topic_0108272803_p46516247141527">Partition field to be extracted, by which a job is split in multiple sub-jobs executed concurrently. For example, <span class="parmvalue" id="dataartsstudio_02_0282__en-us_topic_0108272803_parmvalue99156290114059"><b>id</b></span>.</p>
</td>
</tr>
<tr id="dataartsstudio_02_0282__en-us_topic_0108272803_row958219377129"><td class="cellrowborder" valign="top" width="22.66%" headers="mcps1.3.2.2.1.5.1.1 "><p id="dataartsstudio_02_0282__en-us_topic_0108272803_p1758363741213">fromJobConfig.usePartition</p>
</td>
<td class="cellrowborder" valign="top" width="19.97%" headers="mcps1.3.2.2.1.5.1.2 "><p id="dataartsstudio_02_0282__en-us_topic_0108272803_p5583173701210">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.669999999999998%" headers="mcps1.3.2.2.1.5.1.3 "><p id="dataartsstudio_02_0282__en-us_topic_0108272803_p358383716121">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="40.699999999999996%" headers="mcps1.3.2.2.1.5.1.4 "><p id="dataartsstudio_02_0282__en-us_topic_0108272803_p413443233320">When data is exported from the Oracle database, data can be extracted from each partition in a partitioned table. When this function is enabled, you can use the <span class="parmname" id="dataartsstudio_02_0282__en-us_topic_0108272803_parmname2079347218"><b>fromJobConfig.partitionList</b></span> parameter to specify the partitions in the Oracle table. This function does not support non-partitioned tables.</p>
</td>
</tr>
<tr id="dataartsstudio_02_0282__en-us_topic_0108272803_row1368818395123"><td class="cellrowborder" valign="top" width="22.66%" headers="mcps1.3.2.2.1.5.1.1 "><p id="dataartsstudio_02_0282__en-us_topic_0108272803_p0688103911216">fromJobConfig.partitionList</p>
</td>
<td class="cellrowborder" valign="top" width="19.97%" headers="mcps1.3.2.2.1.5.1.2 "><p id="dataartsstudio_02_0282__en-us_topic_0108272803_p4688113921213">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.669999999999998%" headers="mcps1.3.2.2.1.5.1.3 "><p id="dataartsstudio_02_0282__en-us_topic_0108272803_p7689203910121">String</p>
</td>
<td class="cellrowborder" valign="top" width="40.699999999999996%" headers="mcps1.3.2.2.1.5.1.4 "><p id="dataartsstudio_02_0282__en-us_topic_0108272803_p14213318336">Oracle table partitions to be migrated. Separate multiple partitions with ampersands (&amp;). If you do not set this parameter, all partitions will be migrated.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="source_job_parameters.html">Source Job Parameters</a></div>
</div>
</div>