doc-exports/docs/dataartsstudio/api-ref/dataartsstudio_02_0303.html
Xiong, Chen Xiao f2733178cc DataArts API 20230329 version
Reviewed-by: Kacur, Michal <michal.kacur@t-systems.com>
Co-authored-by: Xiong, Chen Xiao <chenxiaoxiong@huawei.com>
Co-committed-by: Xiong, Chen Xiao <chenxiaoxiong@huawei.com>
2023-06-29 16:21:21 +00:00

184 lines
17 KiB
HTML

<a name="dataartsstudio_02_0303"></a><a name="dataartsstudio_02_0303"></a>
<h1 class="topictitle1">To DCS</h1>
<div id="body8662426"><div class="section" id="dataartsstudio_02_0303__en-us_topic_0108272802_section33401108172339"><h4 class="sectiontitle">Sample JSON File</h4><pre class="screen" id="dataartsstudio_02_0303__en-us_topic_0108272802_screen27582555112448"> "to-config-values": {
"configs": [
{
"inputs": [
{
"name": "toJobConfig.isBatchMigration",
"value": "false"
},
{
"name": "toJobConfig.shouldClearDatabase",
"value": "false"
},
{
"name": "toJobConfig.keyPrefix",
"value": "cdm_string"
},
{
"name": "toJobConfig.keySeparator",
"value": ":"
},
{
"name": "toJobConfig.primaryKeyList",
"value": "1"
},
{
"name": "toJobConfig.valueStoreType",
"value": "STRING"
},
{
"name": "toJobConfig.valueSeparator",
"value": ","
},
{
"name": "toJobConfig.columnList",
"value": "1&amp;2&amp;3&amp;4&amp;5&amp;6&amp;7&amp;8&amp;9&amp;10&amp;11&amp;12"
}
],
"name": "toJobConfig"
}
]
}</pre>
</div>
<div class="section" id="dataartsstudio_02_0303__en-us_topic_0108272802_section16885145112454"><h4 class="sectiontitle">Parameter Description</h4><ul id="dataartsstudio_02_0303__en-us_topic_0108272802_ul6457359515412"><li id="dataartsstudio_02_0303__en-us_topic_0108272802_li4429145015412">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0303__en-us_topic_0108272802_table6307873415412" frame="border" border="1" rules="all"><thead align="left"><tr id="dataartsstudio_02_0303__en-us_topic_0108272802_row2882542015412"><th align="left" class="cellrowborder" valign="top" width="22.657734226577343%" id="mcps1.3.2.2.1.1.1.5.1.1"><p id="dataartsstudio_02_0303__en-us_topic_0108272802_p5315765115412">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.157984201579843%" id="mcps1.3.2.2.1.1.1.5.1.2"><p id="dataartsstudio_02_0303__en-us_topic_0108272802_p1080249515412">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.2983701629837%" id="mcps1.3.2.2.1.1.1.5.1.3"><p id="dataartsstudio_02_0303__en-us_topic_0108272802_p258693615412">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40.885911408859116%" id="mcps1.3.2.2.1.1.1.5.1.4"><p id="dataartsstudio_02_0303__en-us_topic_0108272802_p821526915412">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dataartsstudio_02_0303__en-us_topic_0108272802_row51350293114814"><td class="cellrowborder" valign="top" width="22.657734226577343%" headers="mcps1.3.2.2.1.1.1.5.1.1 "><p id="dataartsstudio_02_0303__en-us_topic_0108272802_p65733030114814">toJobConfig.isBatchMigration</p>
</td>
<td class="cellrowborder" valign="top" width="20.157984201579843%" headers="mcps1.3.2.2.1.1.1.5.1.2 "><p id="dataartsstudio_02_0303__en-us_topic_0108272802_p22775208114814">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.2983701629837%" headers="mcps1.3.2.2.1.1.1.5.1.3 "><p id="dataartsstudio_02_0303__en-us_topic_0108272802_p32852546114814">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="40.885911408859116%" headers="mcps1.3.2.2.1.1.1.5.1.4 "><p id="dataartsstudio_02_0303__en-us_topic_0108272802_p43810589114814">Whether to migrate all data in the database</p>
</td>
</tr>
<tr id="dataartsstudio_02_0303__en-us_topic_0108272802_row53262839115011"><td class="cellrowborder" valign="top" width="22.657734226577343%" headers="mcps1.3.2.2.1.1.1.5.1.1 "><p id="dataartsstudio_02_0303__en-us_topic_0108272802_p19322672115011">toJobConfig.shouldClearDatabase</p>
</td>
<td class="cellrowborder" valign="top" width="20.157984201579843%" headers="mcps1.3.2.2.1.1.1.5.1.2 "><p id="dataartsstudio_02_0303__en-us_topic_0108272802_p21632561115011">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.2983701629837%" headers="mcps1.3.2.2.1.1.1.5.1.3 "><p id="dataartsstudio_02_0303__en-us_topic_0108272802_p7407011115011">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="40.885911408859116%" headers="mcps1.3.2.2.1.1.1.5.1.4 "><p id="dataartsstudio_02_0303__en-us_topic_0108272802_p63097005115011">Whether to clear data before import</p>
</td>
</tr>
<tr id="dataartsstudio_02_0303__en-us_topic_0108272802_row6145707115412"><td class="cellrowborder" valign="top" width="22.657734226577343%" headers="mcps1.3.2.2.1.1.1.5.1.1 "><p id="dataartsstudio_02_0303__en-us_topic_0108272802_p40748341144217">toJobConfig.keyPrefix</p>
</td>
<td class="cellrowborder" valign="top" width="20.157984201579843%" headers="mcps1.3.2.2.1.1.1.5.1.2 "><p id="dataartsstudio_02_0303__en-us_topic_0108272802_p12281354144217">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16.2983701629837%" headers="mcps1.3.2.2.1.1.1.5.1.3 "><p id="dataartsstudio_02_0303__en-us_topic_0108272802_p55265640144217">String</p>
</td>
<td class="cellrowborder" valign="top" width="40.885911408859116%" headers="mcps1.3.2.2.1.1.1.5.1.4 "><p id="dataartsstudio_02_0303__en-us_topic_0108272802_p32290553155944">Key prefix, which is similar to the table name of a relational database</p>
<p id="dataartsstudio_02_0303__en-us_topic_0108272802_p47331830144217">Mapping between Redis and the association table: <em id="dataartsstudio_02_0303__en-us_topic_0108272802_i842352697154746">Name of the association table + delimiter</em> is a Redis key, and a row of data in the association table is a Redis value.</p>
</td>
</tr>
<tr id="dataartsstudio_02_0303__en-us_topic_0108272802_row3532522715412"><td class="cellrowborder" valign="top" width="22.657734226577343%" headers="mcps1.3.2.2.1.1.1.5.1.1 "><p id="dataartsstudio_02_0303__en-us_topic_0108272802_p31423427144217">toJobConfig.keySeparator</p>
</td>
<td class="cellrowborder" valign="top" width="20.157984201579843%" headers="mcps1.3.2.2.1.1.1.5.1.2 "><p id="dataartsstudio_02_0303__en-us_topic_0108272802_p62269650144217">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16.2983701629837%" headers="mcps1.3.2.2.1.1.1.5.1.3 "><p id="dataartsstudio_02_0303__en-us_topic_0108272802_p10676914144217">String</p>
</td>
<td class="cellrowborder" valign="top" width="40.885911408859116%" headers="mcps1.3.2.2.1.1.1.5.1.4 "><p id="dataartsstudio_02_0303__en-us_topic_0108272802_p59523723144217">Key delimiter, which separates the association table and primary key</p>
</td>
</tr>
<tr id="dataartsstudio_02_0303__en-us_topic_0108272802_row2888033144824"><td class="cellrowborder" valign="top" width="22.657734226577343%" headers="mcps1.3.2.2.1.1.1.5.1.1 "><p id="dataartsstudio_02_0303__en-us_topic_0108272802_p32604129144824">toJobConfig.primaryKeyList</p>
</td>
<td class="cellrowborder" valign="top" width="20.157984201579843%" headers="mcps1.3.2.2.1.1.1.5.1.2 "><p id="dataartsstudio_02_0303__en-us_topic_0108272802_p23688773144824">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16.2983701629837%" headers="mcps1.3.2.2.1.1.1.5.1.3 "><p id="dataartsstudio_02_0303__en-us_topic_0108272802_p39742454144824">String</p>
</td>
<td class="cellrowborder" valign="top" width="40.885911408859116%" headers="mcps1.3.2.2.1.1.1.5.1.4 "><p id="dataartsstudio_02_0303__en-us_topic_0108272802_p65022171144824">List of primary keys. Use <span class="parmvalue" id="dataartsstudio_02_0303__en-us_topic_0108272802_parmvalue20376277918531"><b>&amp;</b></span> to separate field names. For example, <span class="parmvalue" id="dataartsstudio_02_0303__en-us_topic_0108272802_parmvalue1911090654185316"><b>id&amp;gid</b></span>.</p>
</td>
</tr>
<tr id="dataartsstudio_02_0303__en-us_topic_0108272802_row130765815412"><td class="cellrowborder" valign="top" width="22.657734226577343%" headers="mcps1.3.2.2.1.1.1.5.1.1 "><p id="dataartsstudio_02_0303__en-us_topic_0108272802_p40468004144217">toJobConfig.valueStoreType</p>
</td>
<td class="cellrowborder" valign="top" width="20.157984201579843%" headers="mcps1.3.2.2.1.1.1.5.1.2 "><p id="dataartsstudio_02_0303__en-us_topic_0108272802_p56682864144217">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16.2983701629837%" headers="mcps1.3.2.2.1.1.1.5.1.3 "><p id="dataartsstudio_02_0303__en-us_topic_0108272802_p27909297144217">Enumeration</p>
</td>
<td class="cellrowborder" valign="top" width="40.885911408859116%" headers="mcps1.3.2.2.1.1.1.5.1.4 "><p id="dataartsstudio_02_0303__en-us_topic_0108272802_p31296545154541">Storage mode of rows of data in the association table on Redis. The options are <span class="parmvalue" id="dataartsstudio_02_0303__en-us_topic_0108272802_parmvalue1417180586173415"><b>string</b></span> and <span class="parmvalue" id="dataartsstudio_02_0303__en-us_topic_0108272802_parmvalue720028074173421"><b>hash</b></span>.</p>
<ul id="dataartsstudio_02_0303__en-us_topic_0108272802_ul1233069154545"><li id="dataartsstudio_02_0303__en-us_topic_0108272802_li48931168154556"><strong id="dataartsstudio_02_0303__en-us_topic_0108272802_b842352706195033">STRING</strong>: indicates that a row of data is stored as a character string, in which columns in the row are separated by <span class="uicontrol" id="dataartsstudio_02_0303__en-us_topic_0108272802_uicontrol1543284009195213"><b>valueSeparator</b></span>.</li><li id="dataartsstudio_02_0303__en-us_topic_0108272802_li45511410154545"><strong id="dataartsstudio_02_0303__en-us_topic_0108272802_b842352706174026">Hash</strong>: indicates that a row of data is stored in <em id="dataartsstudio_02_0303__en-us_topic_0108272802_i84235269711619">column name:column value</em> format in the hash table.</li></ul>
</td>
</tr>
<tr id="dataartsstudio_02_0303__en-us_topic_0108272802_row6489782015412"><td class="cellrowborder" valign="top" width="22.657734226577343%" headers="mcps1.3.2.2.1.1.1.5.1.1 "><p id="dataartsstudio_02_0303__en-us_topic_0108272802_p23762624144217">toJobConfig.valueSeparator</p>
</td>
<td class="cellrowborder" valign="top" width="20.157984201579843%" headers="mcps1.3.2.2.1.1.1.5.1.2 "><p id="dataartsstudio_02_0303__en-us_topic_0108272802_p45724355144217">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.2983701629837%" headers="mcps1.3.2.2.1.1.1.5.1.3 "><p id="dataartsstudio_02_0303__en-us_topic_0108272802_p12685312144217">String</p>
</td>
<td class="cellrowborder" valign="top" width="40.885911408859116%" headers="mcps1.3.2.2.1.1.1.5.1.4 "><p id="dataartsstudio_02_0303__en-us_topic_0108272802_p20877341144217">Value delimiter. The default value is <span class="parmvalue" id="dataartsstudio_02_0303__en-us_topic_0108272802_parmvalue272309108115033"><b>\tab</b></span>. This parameter is valid when <span class="parmname" id="dataartsstudio_02_0303__en-us_topic_0108272802_parmname882886700174327"><b>valueStoreType</b></span> is set to <span class="parmvalue" id="dataartsstudio_02_0303__en-us_topic_0108272802_parmvalue1221422554174335"><b>string</b></span>.</p>
</td>
</tr>
<tr id="dataartsstudio_02_0303__en-us_topic_0108272802_row5037735615412"><td class="cellrowborder" valign="top" width="22.657734226577343%" headers="mcps1.3.2.2.1.1.1.5.1.1 "><p id="dataartsstudio_02_0303__en-us_topic_0108272802_p52978520144217">toJobConfig.columnList</p>
</td>
<td class="cellrowborder" valign="top" width="20.157984201579843%" headers="mcps1.3.2.2.1.1.1.5.1.2 "><p id="dataartsstudio_02_0303__en-us_topic_0108272802_p63401693144217">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.2983701629837%" headers="mcps1.3.2.2.1.1.1.5.1.3 "><p id="dataartsstudio_02_0303__en-us_topic_0108272802_p35263486144217">String</p>
</td>
<td class="cellrowborder" valign="top" width="40.885911408859116%" headers="mcps1.3.2.2.1.1.1.5.1.4 "><p id="dataartsstudio_02_0303__en-us_topic_0108272802_p37770149144217">List of fields to be written. Use <span class="parmvalue" id="dataartsstudio_02_0303__en-us_topic_0108272802_parmvalue361045875114827"><b>&amp;</b></span> to separate field names. For example, <span class="parmvalue" id="dataartsstudio_02_0303__en-us_topic_0108272802_parmvalue1597360760113647"><b>id&amp;gid&amp;name</b></span>.</p>
</td>
</tr>
<tr id="dataartsstudio_02_0303__en-us_topic_0108272802_row5114066314427"><td class="cellrowborder" valign="top" width="22.657734226577343%" headers="mcps1.3.2.2.1.1.1.5.1.1 "><p id="dataartsstudio_02_0303__en-us_topic_0108272802_p19804405144217">toJobConfig.formats</p>
</td>
<td class="cellrowborder" valign="top" width="20.157984201579843%" headers="mcps1.3.2.2.1.1.1.5.1.2 "><p id="dataartsstudio_02_0303__en-us_topic_0108272802_p60652949144217">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.2983701629837%" headers="mcps1.3.2.2.1.1.1.5.1.3 "><p id="dataartsstudio_02_0303__en-us_topic_0108272802_p13941846144217">Data structure</p>
</td>
<td class="cellrowborder" valign="top" width="40.885911408859116%" headers="mcps1.3.2.2.1.1.1.5.1.4 "><p id="dataartsstudio_02_0303__en-us_topic_0108272802_p55547743144217">Time format. For details, see <a href="#dataartsstudio_02_0303__en-us_topic_0108272802_li27488828155343">Description of the toJobConfig.formats parameter</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="dataartsstudio_02_0303__en-us_topic_0108272802_li27488828155343"><a name="dataartsstudio_02_0303__en-us_topic_0108272802_li27488828155343"></a><a name="en-us_topic_0108272802_li27488828155343"></a>Description of the <strong id="dataartsstudio_02_0303__en-us_topic_0108272802_b842352706155349">toJobConfig.formats</strong> parameter
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0303__en-us_topic_0108272802_t4477f05d1bc94e6585dbf45b426fe73b" frame="border" border="1" rules="all"><thead align="left"><tr id="dataartsstudio_02_0303__en-us_topic_0108272802_r006f9b6d73e34ee38a8da48d147b1c3d"><th align="left" class="cellrowborder" valign="top" width="20.987901209879013%" id="mcps1.3.2.2.2.2.1.5.1.1"><p id="dataartsstudio_02_0303__en-us_topic_0108272802_a618d428378ff442781fa69141f57133c">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.567843215678433%" id="mcps1.3.2.2.2.2.1.5.1.2"><p id="dataartsstudio_02_0303__en-us_topic_0108272802_a96a07b646a644893909fe84615e3bbc6">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.25827417258274%" id="mcps1.3.2.2.2.2.1.5.1.3"><p id="dataartsstudio_02_0303__en-us_topic_0108272802_a3da9057af16440649870696d74c7ef77">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40.18598140185981%" id="mcps1.3.2.2.2.2.1.5.1.4"><p id="dataartsstudio_02_0303__en-us_topic_0108272802_ac62dfcfb79394987b66d2878c3613c57">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dataartsstudio_02_0303__en-us_topic_0108272802_rf8412f8b38204d1aaffe11495490bbdf"><td class="cellrowborder" valign="top" width="20.987901209879013%" headers="mcps1.3.2.2.2.2.1.5.1.1 "><p id="dataartsstudio_02_0303__en-us_topic_0108272802_a08e134ceba9449b2966538d4df4370c1">name</p>
</td>
<td class="cellrowborder" valign="top" width="21.567843215678433%" headers="mcps1.3.2.2.2.2.1.5.1.2 "><p id="dataartsstudio_02_0303__en-us_topic_0108272802_abd29c5b76a954984b63731ec0cfd8a3e">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.25827417258274%" headers="mcps1.3.2.2.2.2.1.5.1.3 "><p id="dataartsstudio_02_0303__en-us_topic_0108272802_aff5ea15506b343b8a2bb3b643da845e7">String</p>
</td>
<td class="cellrowborder" valign="top" width="40.18598140185981%" headers="mcps1.3.2.2.2.2.1.5.1.4 "><p id="dataartsstudio_02_0303__en-us_topic_0108272802_ab83a5ff86b694422a9ddcff4c2ac3f83">Column number. For example, <span class="parmvalue" id="dataartsstudio_02_0303__en-us_topic_0108272802_pb23c9f7a2da0470dacd54efded1f0766"><b>1</b></span>.</p>
</td>
</tr>
<tr id="dataartsstudio_02_0303__en-us_topic_0108272802_r3a96a7d4a75244d597ac1fdc77be8d63"><td class="cellrowborder" valign="top" width="20.987901209879013%" headers="mcps1.3.2.2.2.2.1.5.1.1 "><p id="dataartsstudio_02_0303__en-us_topic_0108272802_ab915fc2b472b492c82e9567cb97a6fb5">value</p>
</td>
<td class="cellrowborder" valign="top" width="21.567843215678433%" headers="mcps1.3.2.2.2.2.1.5.1.2 "><p id="dataartsstudio_02_0303__en-us_topic_0108272802_a648e844f17ec4610919a4724b588a213">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.25827417258274%" headers="mcps1.3.2.2.2.2.1.5.1.3 "><p id="dataartsstudio_02_0303__en-us_topic_0108272802_ade2ba95d5ebb47928f648480dd039c4e">String</p>
</td>
<td class="cellrowborder" valign="top" width="40.18598140185981%" headers="mcps1.3.2.2.2.2.1.5.1.4 "><p id="dataartsstudio_02_0303__en-us_topic_0108272802_a48836c62e216482a9f510b0d7401dc3a">Time format. For example, <em id="dataartsstudio_02_0303__en-us_topic_0108272802_i842352697151613">yyyy-MM-dd</em>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dataartsstudio_02_0295.html">Destination Job Parameters</a></div>
</div>
</div>