forked from docs/doc-exports
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>
527 lines
44 KiB
HTML
527 lines
44 KiB
HTML
<a name="dli_02_0102"></a><a name="dli_02_0102"></a>
|
|
|
|
<h1 class="topictitle1">Submitting a SQL Job (Recommended)</h1>
|
|
<div id="body1516173559148"><div class="section" id="dli_02_0102__s51df1f9bf4784cf4a56c09b3973a2adc"><h4 class="sectiontitle">Function</h4><p id="dli_02_0102__p19059616154727">This API is used to submit jobs to a queue using SQL statements.</p>
|
|
<p id="dli_02_0102__p28587776153724">The job types support DDL, DCL, IMPORT, QUERY, and INSERT. The IMPORT function is the same as that described in <a href="dli_02_0019.html">Importing Data (Deprecated)</a>. The difference lies in the implementation method.</p>
|
|
<p id="dli_02_0102__p61093487155417">Additionally, you can use other APIs to query and manage jobs. For details, see the following sections:</p>
|
|
<ul id="dli_02_0102__ul57265221155430"><li id="dli_02_0102__li2265332155430"><a href="dli_02_0021.html">Querying Job Status</a></li><li id="dli_02_0102__li63874426155442"><a href="dli_02_0022.html">Querying Job Details</a></li><li id="dli_02_0102__li22944132155456"><a href="dli_02_0024.html">Exporting Query Results</a></li><li id="dli_02_0102__li55079334155611"><a href="dli_02_0025.html">Querying All Jobs</a></li><li id="dli_02_0102__li471186116448"><a href="dli_02_0104.html">Canceling a Job (Recommended)</a></li></ul>
|
|
<div class="note" id="dli_02_0102__note610404721091"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="dli_02_0102__p6830133310502">This API is synchronous if <span class="parmname" id="dli_02_0102__parmname2973176210107"><b>job_type</b></span> in the response message is <span class="parmvalue" id="dli_02_0102__parmvalue6625926910107"><b>DCL</b></span>.</p>
|
|
</div></div>
|
|
</div>
|
|
<div class="section" id="dli_02_0102__s807a09edd221483999c7c51233072a4a"><h4 class="sectiontitle">URI</h4><ul id="dli_02_0102__en-us_topic_0069077806_ul16583492"><li id="dli_02_0102__en-us_topic_0069077806_li15033705">URI format<p id="dli_02_0102__p39332129102626"><a name="dli_02_0102__en-us_topic_0069077806_li15033705"></a><a name="en-us_topic_0069077806_li15033705"></a>POST /v1.0/{project_id}/jobs/submit-job</p>
|
|
</li><li id="dli_02_0102__li19112104310524">Parameter descriptions
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0102__en-us_topic_0069077806_table9770605" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameter</caption><thead align="left"><tr id="dli_02_0102__en-us_topic_0069077806_row35653836"><th align="left" class="cellrowborder" valign="top" width="14.27%" id="mcps1.3.2.2.2.1.2.5.1.1"><p id="dli_02_0102__en-us_topic_0069077806_p14983541266">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="11.16%" id="mcps1.3.2.2.2.1.2.5.1.2"><p id="dli_02_0102__en-us_topic_0069077806_p9981547619">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="11.3%" id="mcps1.3.2.2.2.1.2.5.1.3"><p id="dli_02_0102__p15306165714487">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="63.27%" id="mcps1.3.2.2.2.1.2.5.1.4"><p id="dli_02_0102__a9de737854caf4be3a07db76909948f18">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0102__row5320171434012"><td class="cellrowborder" valign="top" width="14.27%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="dli_02_0102__en-us_topic_0069077803_p43412436">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.16%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="dli_02_0102__en-us_topic_0069077803_p26746391">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.3%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="dli_02_0102__p1930695754816">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.27%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="dli_02_0102__p12841111193519"><strong id="dli_02_0102__b15239451454042">Definition</strong></p>
|
|
<p id="dli_02_0102__p18513202722714">Project ID, which is used for resource isolation. For how to obtain a project ID, see <a href="dli_02_0183.html">Obtaining a Project ID</a>.</p>
|
|
<p id="dli_02_0102__p476513559276">Example: <strong id="dli_02_0102__b195410050542745">48cc2c48765f481480c7db940d6409d1</strong></p>
|
|
<p id="dli_02_0102__p1779921913513"><strong id="dli_02_0102__b73646095141047">Constraints</strong></p>
|
|
<p id="dli_02_0102__p16166233143510">None</p>
|
|
<p id="dli_02_0102__p19789423113517"><strong id="dli_02_0102__b15037465704051">Range</strong></p>
|
|
<p id="dli_02_0102__p20527112713361">The value can contain 1 to 64 characters. Only letters and digits are allowed.</p>
|
|
<p id="dli_02_0102__p1049772653519"><strong id="dli_02_0102__b7277952814735">Default Value</strong></p>
|
|
<p id="dli_02_0102__p6928441113513">None</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dli_02_0102__s46f967e8024f453cb6cd43f3af264950"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0102__table6376584143542" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameters</caption><thead align="left"><tr id="dli_02_0102__row19110893143542"><th align="left" class="cellrowborder" valign="top" width="14.549999999999999%" id="mcps1.3.3.2.2.5.1.1"><p id="dli_02_0102__p42934984143542">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10.79%" id="mcps1.3.3.2.2.5.1.2"><p id="dli_02_0102__p55181642143542">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.3%" id="mcps1.3.3.2.2.5.1.3"><p id="dli_02_0102__p40528033143542">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="58.36%" id="mcps1.3.3.2.2.5.1.4"><p id="dli_02_0102__p61545269143542">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0102__row16818917143542"><td class="cellrowborder" valign="top" width="14.549999999999999%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0102__p4478514143542">sql</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.79%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0102__p27215339143542">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.3%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0102__p56958849143542">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.36%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0102__p175192419380"><strong id="dli_02_0102__b061091719312">Definition</strong></p>
|
|
<p id="dli_02_0102__p3867172723818">SQL statement to be executed</p>
|
|
<p id="dli_02_0102__p45313435387"><strong id="dli_02_0102__b107141237235">Constraints</strong></p>
|
|
<p id="dli_02_0102__p1237332912382">None</p>
|
|
<p id="dli_02_0102__p1118418466385"><strong id="dli_02_0102__b126518421234">Range</strong></p>
|
|
<p id="dli_02_0102__p422533193817">None</p>
|
|
<p id="dli_02_0102__p880224733815"><strong id="dli_02_0102__b1054411471631">Default Value</strong></p>
|
|
<p id="dli_02_0102__p7905184711488">None</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0102__row48821488143542"><td class="cellrowborder" valign="top" width="14.549999999999999%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0102__p17152532143542">currentdb</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.79%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0102__p47177872143542">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.3%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0102__p63311321143542">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.36%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0102__p13824172511120"><strong id="dli_02_0102__b712391811315">Definition</strong></p>
|
|
<p id="dli_02_0102__p27943382143542">Database where the SQL statement is executed. This parameter does not need to be configured during database creation.</p>
|
|
<p id="dli_02_0102__p582412516112"><strong id="dli_02_0102__b1026714381730">Constraints</strong></p>
|
|
<p id="dli_02_0102__p582415251417">None</p>
|
|
<p id="dli_02_0102__p1682417253112"><strong id="dli_02_0102__b26771243831">Range</strong></p>
|
|
<p id="dli_02_0102__p3824825518">The value cannot contain only digits or start with an underscore (_). Only digits, letters, and underscores (_) are allowed.</p>
|
|
<p id="dli_02_0102__p158244254110"><strong id="dli_02_0102__b1755411486311">Default Value</strong></p>
|
|
<p id="dli_02_0102__p5824132514117">None</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0102__row47659205154318"><td class="cellrowborder" valign="top" width="14.549999999999999%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0102__p1846530915443">queue_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.79%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0102__p3009358515443">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.3%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0102__p6674625215443">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.36%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0102__p4032919112"><strong id="dli_02_0102__b21242181232">Definition</strong></p>
|
|
<p id="dli_02_0102__p32836715443">Name of the queue to which the job is to be submitted</p>
|
|
<p id="dli_02_0102__p1109298113"><strong id="dli_02_0102__b1026893816318">Constraints</strong></p>
|
|
<p id="dli_02_0102__p5022914110">None</p>
|
|
<p id="dli_02_0102__p306291313"><strong id="dli_02_0102__b367944316315">Range</strong></p>
|
|
<p id="dli_02_0102__p8017291410">The name cannot contain only digits or start with an underscore (_). Only digits, letters, and underscores (_) are allowed.</p>
|
|
<p id="dli_02_0102__p1014291712"><strong id="dli_02_0102__b205566481135">Default Value</strong></p>
|
|
<p id="dli_02_0102__p1500291114">None</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0102__row57451725143542"><td class="cellrowborder" valign="top" width="14.549999999999999%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0102__p36740211143542">conf</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.79%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0102__p23167106143542">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.3%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0102__p64596322143542">Array of strings</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.36%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0102__p1239313017115"><strong id="dli_02_0102__b01252181235">Definition</strong></p>
|
|
<p id="dli_02_0102__p339314302019">You can set the parameter in key-value pairs.</p>
|
|
<p id="dli_02_0102__p173931830416"><strong id="dli_02_0102__b22692038737">Constraints</strong></p>
|
|
<p id="dli_02_0102__p1639316306115">None</p>
|
|
<p id="dli_02_0102__p539311301516"><strong id="dli_02_0102__b1067919438317">Range</strong></p>
|
|
<p id="dli_02_0102__p133931230113">For details about the supported configuration items, see <a href="#dli_02_0102__table334825142314">Table 3</a>.</p>
|
|
<p id="dli_02_0102__p93931830914"><strong id="dli_02_0102__b1355615481319">Default Value</strong></p>
|
|
<p id="dli_02_0102__p1339314300118">None</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0102__row12919491403"><td class="cellrowborder" valign="top" width="14.549999999999999%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0102__p49794914011">tags</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.79%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0102__p597149114018">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.3%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0102__p451066135816">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.36%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0102__p15330311116"><strong id="dli_02_0102__b1912519181318">Definition</strong></p>
|
|
<p id="dli_02_0102__p1153310311817">Job tags. For details, see <a href="#dli_02_0102__table9391124139">Table 4</a>.</p>
|
|
<p id="dli_02_0102__p853343115116"><strong id="dli_02_0102__b15269103810310">Constraints</strong></p>
|
|
<p id="dli_02_0102__p053314313119">None</p>
|
|
<p id="dli_02_0102__p953310311816"><strong id="dli_02_0102__b116791143338">Range</strong></p>
|
|
<p id="dli_02_0102__p1553373112111">None</p>
|
|
<p id="dli_02_0102__p15336311611"><strong id="dli_02_0102__b135565485311">Default Value</strong></p>
|
|
<p id="dli_02_0102__p153316316113">None</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0102__row17297103119146"><td class="cellrowborder" valign="top" width="14.549999999999999%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0102__p115341838131416">engine_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.79%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0102__p12991314140">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.3%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0102__p52996312141">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.36%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0102__p1119623311110"><strong id="dli_02_0102__b1212571817316">Definition</strong></p>
|
|
<p id="dli_02_0102__p12174591189">Type of the engine that executes jobs.</p>
|
|
<p id="dli_02_0102__p121964331115"><strong id="dli_02_0102__b126923816315">Constraints</strong></p>
|
|
<p id="dli_02_0102__p21961133917">None</p>
|
|
<p id="dli_02_0102__p14196183318119"><strong id="dli_02_0102__b36800435314">Range</strong></p>
|
|
<ul id="dli_02_0102__ul137867285134"><li id="dli_02_0102__li187861428141316"><strong id="dli_02_0102__b57568660744324">spark</strong>: Spark engine</li></ul>
|
|
<p id="dli_02_0102__p191961433817"><strong id="dli_02_0102__b175571488317">Default Value</strong></p>
|
|
<p id="dli_02_0102__p11968331413">spark</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="dli_02_0102__table334825142314"></a><a name="table334825142314"></a><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0102__table334825142314" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Configuration parameters description</caption><thead align="left"><tr id="dli_02_0102__row66396519230"><th align="left" class="cellrowborder" valign="top" width="44.4%" id="mcps1.3.3.3.2.3.1.1"><p id="dli_02_0102__p463913514234">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="55.60000000000001%" id="mcps1.3.3.3.2.3.1.2"><p id="dli_02_0102__p1963920542313">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0102__row1363935122313"><td class="cellrowborder" valign="top" width="44.4%" headers="mcps1.3.3.3.2.3.1.1 "><p id="dli_02_0102__p56404542316">spark.sql.files.maxRecordsPerFile</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.60000000000001%" headers="mcps1.3.3.3.2.3.1.2 "><p id="dli_02_0102__p1344835113113"><strong id="dli_02_0102__b112918189315">Definition</strong></p>
|
|
<p id="dli_02_0102__p204481451515">Maximum number of records to be written into a single file. If the value is zero or negative, there is no limit.</p>
|
|
<p id="dli_02_0102__p10448175110111"><strong id="dli_02_0102__b132734388316">Constraints</strong></p>
|
|
<p id="dli_02_0102__p14448351017">None</p>
|
|
<p id="dli_02_0102__p84484511215"><strong id="dli_02_0102__b9683943436">Range</strong></p>
|
|
<p id="dli_02_0102__p24480511110">None</p>
|
|
<p id="dli_02_0102__p64481251412"><strong id="dli_02_0102__b1656034818319">Default Value</strong></p>
|
|
<p id="dli_02_0102__p17448185115118">0</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0102__row8640135142317"><td class="cellrowborder" valign="top" width="44.4%" headers="mcps1.3.3.3.2.3.1.1 "><p id="dli_02_0102__p664017510239">spark.sql.autoBroadcastJoinThreshold</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.60000000000001%" headers="mcps1.3.3.3.2.3.1.2 "><p id="dli_02_0102__p3322853312"><strong id="dli_02_0102__b1012912181839">Definition</strong></p>
|
|
<p id="dli_02_0102__p15640157231">Maximum size of the table that displays all working nodes when a connection is executed. You can set this parameter to <span class="parmvalue" id="dli_02_0102__parmvalue10816165872414"><b>-1</b></span> to disable the display.</p>
|
|
<p id="dli_02_0102__p23220531120"><strong id="dli_02_0102__b627311387317">Constraints</strong></p>
|
|
<p id="dli_02_0102__p166418366254">Currently, only the configuration unit metastore table that runs the <b><span class="cmdname" id="dli_02_0102__cmdname86941634172615">ANALYZE TABLE COMPUTE statistics noscan</span></b> command and the file-based data source table that directly calculates statistics based on data files are supported.</p>
|
|
<p id="dli_02_0102__p153221053111"><strong id="dli_02_0102__b1684194310317">Range</strong></p>
|
|
<p id="dli_02_0102__p3322155319119">None</p>
|
|
<p id="dli_02_0102__p3322165318115"><strong id="dli_02_0102__b756110489320">Default Value</strong></p>
|
|
<p id="dli_02_0102__p17322145315118">209715200</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0102__row364020522314"><td class="cellrowborder" valign="top" width="44.4%" headers="mcps1.3.3.3.2.3.1.1 "><p id="dli_02_0102__p146401254236">spark.sql.shuffle.partitions</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.60000000000001%" headers="mcps1.3.3.3.2.3.1.2 "><p id="dli_02_0102__p13114755312"><strong id="dli_02_0102__b1213013181536">Definition</strong></p>
|
|
<p id="dli_02_0102__p2114125514114">Default number of partitions used to filter data for join or aggregation.</p>
|
|
<p id="dli_02_0102__p3114655314"><strong id="dli_02_0102__b1727316381734">Constraints</strong></p>
|
|
<p id="dli_02_0102__p111148551118">None</p>
|
|
<p id="dli_02_0102__p211412551311"><strong id="dli_02_0102__b468413437314">Range</strong></p>
|
|
<p id="dli_02_0102__p411415551617">None</p>
|
|
<p id="dli_02_0102__p01146551416"><strong id="dli_02_0102__b145616487313">Default Value</strong></p>
|
|
<p id="dli_02_0102__p511410551617">200</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0102__row1664018513237"><td class="cellrowborder" valign="top" width="44.4%" headers="mcps1.3.3.3.2.3.1.1 "><p id="dli_02_0102__p464005132313">spark.sql.dynamicPartitionOverwrite.enabled</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.60000000000001%" headers="mcps1.3.3.3.2.3.1.2 "><p id="dli_02_0102__p1382215613116"><strong id="dli_02_0102__b813015181832">Definition</strong></p>
|
|
<p id="dli_02_0102__p6493378818">Whether DLI deletes all partitions that meet the conditions before overwriting the partitions</p>
|
|
<p id="dli_02_0102__p168224561916"><strong id="dli_02_0102__b1027414381534">Constraints</strong></p>
|
|
<p id="dli_02_0102__p19822956918">None</p>
|
|
<p id="dli_02_0102__p38226561012"><strong id="dli_02_0102__b868484315317">Range</strong></p>
|
|
<ul id="dli_02_0102__ul193161338816"><li id="dli_02_0102__li2031615331189">When set to <strong id="dli_02_0102__b18106528151620">false</strong>, DLI will delete all partitions that meet the conditions before overwriting them.<p id="dli_02_0102__p1779118343818">For example, if you set <strong id="dli_02_0102__b143841725142519">false</strong> and use INSERT OVERWRITE to write partition 2021-02 to a partitioned table that has the 2021-01 partition, this partition will be deleted.</p>
|
|
</li><li id="dli_02_0102__li1731653312819">When set to <strong id="dli_02_0102__b08532032131612">true</strong>, DLI will not delete partitions in advance, but will overwrite partitions with data written during runtime.</li></ul>
|
|
<p id="dli_02_0102__p1682216566115"><strong id="dli_02_0102__b256113488318">Default Value</strong></p>
|
|
<p id="dli_02_0102__p1382214563110">false</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0102__row56403510234"><td class="cellrowborder" valign="top" width="44.4%" headers="mcps1.3.3.3.2.3.1.1 "><p id="dli_02_0102__p106403522310">spark.sql.files.maxPartitionBytes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.60000000000001%" headers="mcps1.3.3.3.2.3.1.2 "><p id="dli_02_0102__p613315581115"><strong id="dli_02_0102__b413013181038">Definition</strong></p>
|
|
<p id="dli_02_0102__p12134175812118">Maximum number of bytes to be packed into a single partition when a file is read.</p>
|
|
<p id="dli_02_0102__p181341658710"><strong id="dli_02_0102__b627413381331">Constraints</strong></p>
|
|
<p id="dli_02_0102__p1513416581513">None</p>
|
|
<p id="dli_02_0102__p513455819116"><strong id="dli_02_0102__b7684543734">Range</strong></p>
|
|
<p id="dli_02_0102__p1013435816117">None</p>
|
|
<p id="dli_02_0102__p1613413581413"><strong id="dli_02_0102__b656214486318">Default Value</strong></p>
|
|
<p id="dli_02_0102__p1713416580118">134217728</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0102__row1364118532316"><td class="cellrowborder" valign="top" width="44.4%" headers="mcps1.3.3.3.2.3.1.1 "><p id="dli_02_0102__p1641751235">spark.sql.badRecordsPath</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.60000000000001%" headers="mcps1.3.3.3.2.3.1.2 "><p id="dli_02_0102__p105891259515"><strong id="dli_02_0102__b171311118332">Definition</strong></p>
|
|
<p id="dli_02_0102__p458915913118">Path of bad records</p>
|
|
<p id="dli_02_0102__p3589205920114"><strong id="dli_02_0102__b5274538834">Constraints</strong></p>
|
|
<p id="dli_02_0102__p1858913591515">None</p>
|
|
<p id="dli_02_0102__p185895591515"><strong id="dli_02_0102__b10685194319313">Range</strong></p>
|
|
<p id="dli_02_0102__p3589459517">None</p>
|
|
<p id="dli_02_0102__p3589115918114"><strong id="dli_02_0102__b75622488315">Default Value</strong></p>
|
|
<p id="dli_02_0102__p65891591715">None</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0102__row5844161611018"><td class="cellrowborder" valign="top" width="44.4%" headers="mcps1.3.3.3.2.3.1.1 "><p id="dli_02_0102__p10133536151012">dli.sql.sqlasync.enabled</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.60000000000001%" headers="mcps1.3.3.3.2.3.1.2 "><p id="dli_02_0102__p1781601121"><strong id="dli_02_0102__b181314189319">Definition</strong></p>
|
|
<p id="dli_02_0102__p13134236121018">Indicates whether DDL and DCL statements are executed asynchronously. The value <span class="parmvalue" id="dli_02_0102__parmvalue97623141853"><b>true</b></span> indicates that asynchronous execution is enabled.</p>
|
|
<p id="dli_02_0102__p87811017216"><strong id="dli_02_0102__b82742384315">Constraints</strong></p>
|
|
<p id="dli_02_0102__p107811303216">None</p>
|
|
<p id="dli_02_0102__p57811009214"><strong id="dli_02_0102__b06856431134">Range</strong></p>
|
|
<p id="dli_02_0102__p5781201729">None</p>
|
|
<p id="dli_02_0102__p57811804218"><strong id="dli_02_0102__b556244820313">Default Value</strong></p>
|
|
<p id="dli_02_0102__p77819011220">true</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0102__row12507743111016"><td class="cellrowborder" valign="top" width="44.4%" headers="mcps1.3.3.3.2.3.1.1 "><p id="dli_02_0102__p350815439108">dli.sql.job.timeout</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.60000000000001%" headers="mcps1.3.3.3.2.3.1.2 "><p id="dli_02_0102__p626013217211"><strong id="dli_02_0102__b1413131818318">Definition</strong></p>
|
|
<p id="dli_02_0102__p10508043181014">Sets the job running timeout interval. If the timeout interval expires, the job is canceled. Unit: second</p>
|
|
<p id="dli_02_0102__p72604212216"><strong id="dli_02_0102__b52751338233">Constraints</strong></p>
|
|
<p id="dli_02_0102__p18260182223">None</p>
|
|
<p id="dli_02_0102__p6260325213"><strong id="dli_02_0102__b1068516431314">Range</strong></p>
|
|
<p id="dli_02_0102__p126017212214">None</p>
|
|
<p id="dli_02_0102__p142601621212"><strong id="dli_02_0102__b256314481034">Default Value</strong></p>
|
|
<p id="dli_02_0102__p17260428216">None</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0102__row116752522392"><td class="cellrowborder" valign="top" width="44.4%" headers="mcps1.3.3.3.2.3.1.1 "><p id="dli_02_0102__p7482420111410">spark.sql.legacy.correlated.scalar.query.enabled</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.60000000000001%" headers="mcps1.3.3.3.2.3.1.2 "><p id="dli_02_0102__p01313420219"><strong id="dli_02_0102__b113214187310">Definition</strong></p>
|
|
<p id="dli_02_0102__p1513154523">Controls the behavior of correlated subqueries.</p>
|
|
<p id="dli_02_0102__p1113111419215"><strong id="dli_02_0102__b1427583816310">Constraints</strong></p>
|
|
<p id="dli_02_0102__p21317415211">None</p>
|
|
<p id="dli_02_0102__p3131174225"><strong id="dli_02_0102__b1068615437319">Range</strong></p>
|
|
<ul id="dli_02_0102__ul8745181711016"><li id="dli_02_0102__li10267165317259"><strong id="dli_02_0102__b18350221114">If set to true:</strong><ul id="dli_02_0102__ul174613114264"><li id="dli_02_0102__li1371018942617">When there is no duplicate data in a subquery, executing a correlated subquery does not require deduplication from the subquery's result.</li><li id="dli_02_0102__li57111692267">If there is duplicate data in a subquery, executing a correlated subquery will result in an error. To resolve this, the subquery's result must be deduplicated using functions such as <strong id="dli_02_0102__b65104717116">max()</strong> or <strong id="dli_02_0102__b14511127121110">min()</strong>.</li></ul>
|
|
</li><li id="dli_02_0102__li574591716102"><strong id="dli_02_0102__b13717092114">If set to false:</strong><p id="dli_02_0102__p77451817181020">Regardless of whether there is duplicate data in a subquery, executing a correlated subquery requires deduplicating the subquery's result using functions such as <strong id="dli_02_0102__b1288165621715">max()</strong> or <strong id="dli_02_0102__b488135651717">min()</strong>. Otherwise, an error will occur.</p>
|
|
</li></ul>
|
|
<p id="dli_02_0102__p513119415218"><strong id="dli_02_0102__b156314484315">Default Value</strong></p>
|
|
<p id="dli_02_0102__p14131184729">false</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0102__row15704182012241"><td class="cellrowborder" valign="top" width="44.4%" headers="mcps1.3.3.3.2.3.1.1 "><p id="dli_02_0102__p2013525463013">spark.sql.optimizer.dynamicPartitionPruning.enabled</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.60000000000001%" headers="mcps1.3.3.3.2.3.1.2 "><p id="dli_02_0102__p117281804311"><strong id="dli_02_0102__b1813261817313">Definition</strong></p>
|
|
<p id="dli_02_0102__p0120112114312">This parameter is used to control whether to enable dynamic partition pruning. Dynamic partition pruning can help reduce the amount of data that needs to be scanned and improve query performance when executing SQL queries.</p>
|
|
<p id="dli_02_0102__p137283017311"><strong id="dli_02_0102__b1827611381430">Constraints</strong></p>
|
|
<p id="dli_02_0102__p67281016315">None</p>
|
|
<p id="dli_02_0102__p1072850232"><strong id="dli_02_0102__b186862431932">Range</strong></p>
|
|
<ul id="dli_02_0102__ul10431123219399"><li id="dli_02_0102__li34312325392">When set to <strong id="dli_02_0102__b680142445310">true</strong>, dynamic partition pruning is enabled. SQL automatically detects and deletes partitions that do not meet the WHERE clause conditions during query. This is useful for tables that have a large number of partitions.</li><li id="dli_02_0102__li18431163263919">If SQL queries contain a large number of nested left join operations and the table has a large number of dynamic partitions, a large number of memory resources may be consumed during data parsing. As a result, the memory of the driver node is insufficient and there are frequent Full GCs.<p id="dli_02_0102__p9628429134018"><a name="dli_02_0102__li18431163263919"></a><a name="li18431163263919"></a>To avoid such issues, you can disable dynamic partition pruning by setting this parameter to <strong id="dli_02_0102__b2293123010538">false</strong>.</p>
|
|
<p id="dli_02_0102__p317112359398">However, disabling this optimization may reduce query performance. Once disabled, Spark does not automatically prune the partitions that do not meet the requirements.</p>
|
|
</li></ul>
|
|
<p id="dli_02_0102__p9728301733"><strong id="dli_02_0102__b356419481332">Default Value</strong></p>
|
|
<p id="dli_02_0102__p27281207317">true</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="dli_02_0102__table9391124139"></a><a name="table9391124139"></a><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0102__table9391124139" frame="border" border="1" rules="all"><caption><b>Table 4 </b>tags parameters</caption><thead align="left"><tr id="dli_02_0102__row1440020130"><th align="left" class="cellrowborder" valign="top" width="12.98%" id="mcps1.3.3.4.2.5.1.1"><p id="dli_02_0102__p194012219139">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.150000000000002%" id="mcps1.3.3.4.2.5.1.2"><p id="dli_02_0102__p540724136">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.66%" id="mcps1.3.3.4.2.5.1.3"><p id="dli_02_0102__p840162161315">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="54.21%" id="mcps1.3.3.4.2.5.1.4"><p id="dli_02_0102__p12238643938">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0102__row194013231317"><td class="cellrowborder" valign="top" width="12.98%" headers="mcps1.3.3.4.2.5.1.1 "><p id="dli_02_0102__p13401329138">key</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.150000000000002%" headers="mcps1.3.3.4.2.5.1.2 "><p id="dli_02_0102__p940102141313">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.66%" headers="mcps1.3.3.4.2.5.1.3 "><p id="dli_02_0102__p64019231317">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.21%" headers="mcps1.3.3.4.2.5.1.4 "><p id="dli_02_0102__p3191102710309"><strong id="dli_02_0102__b20640859604042">Definition</strong></p>
|
|
<p id="dli_02_0102__p1519272783014">Tag key</p>
|
|
<p id="dli_02_0102__p51928275306"><strong id="dli_02_0102__b160656896741047">Constraints</strong></p>
|
|
<p id="dli_02_0102__p1819219272301">None</p>
|
|
<p id="dli_02_0102__p2192827103014"><strong id="dli_02_0102__b17178331344051">Range</strong></p>
|
|
<p id="dli_02_0102__p74267124517">A tag key can contain up to 128 characters, cannot start or end with a space, and cannot start with <strong id="dli_02_0102__b1540510153199">_sys_</strong>. Only letters, digits, spaces, and the following special characters are allowed: _.:+-@</p>
|
|
<p id="dli_02_0102__p5192527143011"><strong id="dli_02_0102__b4400801754735">Default Value</strong></p>
|
|
<p id="dli_02_0102__p419222733011">None</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0102__row1141142181320"><td class="cellrowborder" valign="top" width="12.98%" headers="mcps1.3.3.4.2.5.1.1 "><p id="dli_02_0102__p164118215134">value</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.150000000000002%" headers="mcps1.3.3.4.2.5.1.2 "><p id="dli_02_0102__p1141112181317">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.66%" headers="mcps1.3.3.4.2.5.1.3 "><p id="dli_02_0102__p174114281318">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54.21%" headers="mcps1.3.3.4.2.5.1.4 "><p id="dli_02_0102__p11880030133011"><strong id="dli_02_0102__b1707288544042">Definition</strong></p>
|
|
<p id="dli_02_0102__p3880123017301">Tag value</p>
|
|
<p id="dli_02_0102__p6880730173011"><strong id="dli_02_0102__b54479926341047">Constraints</strong></p>
|
|
<p id="dli_02_0102__p08801230113017">None</p>
|
|
<p id="dli_02_0102__p12880153014305"><strong id="dli_02_0102__b18658450204051">Range</strong></p>
|
|
<p id="dli_02_0102__p17199145217452">A tag value can contain up to 255 characters. Only letters, digits, spaces, and the following special characters are allowed: _.:+-@</p>
|
|
<p id="dli_02_0102__p1088011301307"><strong id="dli_02_0102__b18084482624735">Default Value</strong></p>
|
|
<p id="dli_02_0102__p20880113017304">None</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dli_02_0102__s04b3bd00c07846478613d3718f637112"><h4 class="sectiontitle">Response Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0102__en-us_topic_0069077806_table43107464" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response parameters</caption><thead align="left"><tr id="dli_02_0102__en-us_topic_0069077806_row12322941"><th align="left" class="cellrowborder" valign="top" width="12.11%" id="mcps1.3.4.2.2.5.1.1"><p id="dli_02_0102__en-us_topic_0069077806_p17344522714">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="9.66%" id="mcps1.3.4.2.2.5.1.2"><p id="dli_02_0102__en-us_topic_0069077806_p3324582718">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.88%" id="mcps1.3.4.2.2.5.1.3"><p id="dli_02_0102__en-us_topic_0069077806_p1633452272">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="61.35%" id="mcps1.3.4.2.2.5.1.4"><p id="dli_02_0102__en-us_topic_0069077806_p18354562712">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0102__en-us_topic_0069077806_row42891778"><td class="cellrowborder" valign="top" width="12.11%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0102__en-us_topic_0069077806_p51681963">is_success</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="9.66%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0102__en-us_topic_0069077806_p25489436">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.88%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0102__en-us_topic_0069077806_p51378430">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.35%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0102__p124019441302"><strong id="dli_02_0102__b3466445934042">Definition</strong></p>
|
|
<p id="dli_02_0102__p1124112448305">Whether the request is successfully executed. <strong id="dli_02_0102__b41873643342222">true</strong> indicates that the request is successfully executed.</p>
|
|
<p id="dli_02_0102__p924115445300"><strong id="dli_02_0102__b5646162324051">Range</strong></p>
|
|
<p id="dli_02_0102__p182413449303">None</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0102__en-us_topic_0069077806_row8129598"><td class="cellrowborder" valign="top" width="12.11%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0102__en-us_topic_0069077806_p54517712">message</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="9.66%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0102__en-us_topic_0069077806_p53858575">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.88%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0102__en-us_topic_0069077806_p468450">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.35%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0102__p492011495564"><strong id="dli_02_0102__b17171211214042">Definition</strong></p>
|
|
<p id="dli_02_0102__p12260115765611">System prompt. If the execution succeeds, this parameter may be left blank.</p>
|
|
<p id="dli_02_0102__p1092044911567"><strong id="dli_02_0102__b16751829434051">Range</strong></p>
|
|
<p id="dli_02_0102__p19920134918566">None</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0102__en-us_topic_0069077806_row5956164"><td class="cellrowborder" valign="top" width="12.11%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0102__en-us_topic_0069077806_p12687257">job_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="9.66%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0102__en-us_topic_0069077806_p21034911">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.88%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0102__en-us_topic_0069077806_p26106237">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.35%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0102__p2036075531610"><strong id="dli_02_0102__b558647384042">Definition</strong></p>
|
|
<p id="dli_02_0102__p836014557168">ID of a job returned after a job is generated and submitted using SQL statements. The job ID can be used to query the job status and results.</p>
|
|
<p id="dli_02_0102__p7360255171620"><strong id="dli_02_0102__b17608334284051">Range</strong></p>
|
|
<p id="dli_02_0102__p173612559161">None</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0102__en-us_topic_0069077806_row39638980"><td class="cellrowborder" valign="top" width="12.11%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0102__en-us_topic_0069077806_p56640774">job_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="9.66%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0102__en-us_topic_0069077806_p24499997">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.88%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0102__en-us_topic_0069077806_p38342769">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.35%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0102__p1361911328313"><strong id="dli_02_0102__b15165878084042">Definition</strong></p>
|
|
<p id="dli_02_0102__p061953213114">Job type</p>
|
|
<p id="dli_02_0102__p26191032103117"><strong id="dli_02_0102__b5856201274051">Range</strong></p>
|
|
<p id="dli_02_0102__p1619632153114"><strong id="dli_02_0102__b61608107214">DDL</strong>, <strong id="dli_02_0102__b10161710152114">DCL</strong>, <strong id="dli_02_0102__b916151042117">IMPORT</strong>, <strong id="dli_02_0102__b1616171072115">EXPORT</strong>, <strong id="dli_02_0102__b916111014213">QUERY</strong>, and <strong id="dli_02_0102__b14161171002119">INSERT</strong>.</p>
|
|
<ul id="dli_02_0102__ul741772872214"><li id="dli_02_0102__li1041882862219"><strong id="dli_02_0102__b949121920234">DDL</strong>: jobs that create, modify, and delete metadata files</li><li id="dli_02_0102__li1141852813224"><strong id="dli_02_0102__b5865152472315">DCL</strong>: jobs that grant and revoke permissions<p id="dli_02_0102__p16270111416276">When <strong id="dli_02_0102__b122385272545">job_type</strong> is set to <strong id="dli_02_0102__b132084306549">DCL</strong>, the operation is synchronous.</p>
|
|
</li><li id="dli_02_0102__li154182028132213"><strong id="dli_02_0102__b846416455236">IMPORT</strong>: jobs that import external data into the database</li><li id="dli_02_0102__li11418142812219"><strong id="dli_02_0102__b1730818412411">EXPORT</strong>: jobs that export data to an external database</li><li id="dli_02_0102__li6418028112217"><strong id="dli_02_0102__b435319337247">QUERY</strong>: jobs that run query statements</li><li id="dli_02_0102__li1541842852212"><strong id="dli_02_0102__b35001343112418">INSERT</strong>: jobs that add new data to tables</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0102__row1822483371311"><td class="cellrowborder" valign="top" width="12.11%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0102__p18224933171318">schema</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="9.66%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0102__p92257338139">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.88%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0102__p1822514331138">Array of Map</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.35%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0102__p85122442186"><strong id="dli_02_0102__b5021869554042">Definition</strong></p>
|
|
<p id="dli_02_0102__p152251533161319">If the statement type is DDL, the column name and type of DDL are displayed.</p>
|
|
<p id="dli_02_0102__p1951234413185"><strong id="dli_02_0102__b3128789924051">Range</strong></p>
|
|
<p id="dli_02_0102__p1351324411820">None</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0102__en-us_topic_0069077806_row34591542"><td class="cellrowborder" valign="top" width="12.11%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0102__en-us_topic_0069077806_p50451552">rows</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="9.66%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0102__en-us_topic_0069077806_p60043939">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.88%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0102__en-us_topic_0069077806_p31720870">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.35%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0102__p17273135415187"><strong id="dli_02_0102__b5997839374042">Definition</strong></p>
|
|
<p id="dli_02_0102__en-us_topic_0069077806_p19253649">When the statement type is DDL and <strong id="dli_02_0102__b1831421712322">dli.sql.sqlasync.enabled</strong> is set to <strong id="dli_02_0102__b0401191919327">false</strong>, the execution results are returned directly. However, only a maximum of 1,000 rows can be returned.</p>
|
|
<p id="dli_02_0102__p5974158171819">If there are more than 1,000 rows, obtain the results asynchronously. That is, when submitting the job, set <em id="dli_02_0102__i552575910815">xxxx</em> to <strong id="dli_02_0102__b124061445915">true</strong>, and then obtain the results from the job bucket configured by DLI. The path of the results on the job bucket can be obtained from the <strong id="dli_02_0102__b1393312366919">result_path</strong> in the return value of the ShowSqlJobStatus API. The full data of the results will be automatically exported to the job bucket.</p>
|
|
<p id="dli_02_0102__p727312545185"><strong id="dli_02_0102__b13237601494051">Range</strong></p>
|
|
<p id="dli_02_0102__p16273654161812">None</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0102__row0688520181920"><td class="cellrowborder" valign="top" width="12.11%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0102__p222905218240">job_mode</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="9.66%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0102__p3229125212417">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.88%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0102__p922911524243">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.35%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0102__p190131471912"><strong id="dli_02_0102__b12776319054042">Definition</strong></p>
|
|
<p id="dli_02_0102__p4229105292420">Job execution mode. Options:</p>
|
|
<ul id="dli_02_0102__ul34491221191913"><li id="dli_02_0102__li16442124112518"><strong id="dli_02_0102__b1386564355617">async</strong>: asynchronous</li><li id="dli_02_0102__li154491221181915"><strong id="dli_02_0102__b57313315255">sync</strong>: synchronous</li></ul>
|
|
<p id="dli_02_0102__p209011214151914"><strong id="dli_02_0102__b5300929154051">Range</strong></p>
|
|
<p id="dli_02_0102__p1390281421916">None</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dli_02_0102__section10171194731415"><h4 class="sectiontitle">Example Request</h4><p id="dli_02_0102__p258671017141">Submit a SQL job. The job execution database and queue are <strong id="dli_02_0102__b6327184815917">db1</strong> and <strong id="dli_02_0102__b9433132414103">default</strong>, respectively. Then, add the tags <strong id="dli_02_0102__b169015273117">workspace=space1</strong> and <strong id="dli_02_0102__b56280378110">jobName=name1</strong> for the job.</p>
|
|
<pre class="screen" id="dli_02_0102__screen58732893165524">{
|
|
"currentdb": "db1",
|
|
"sql": "desc table1",
|
|
"queue_name": "default",
|
|
"conf": [
|
|
"dli.sql.shuffle.partitions = 200"
|
|
],
|
|
"tags": [
|
|
{
|
|
"key": "workspace",
|
|
"value": "space1"
|
|
},
|
|
{
|
|
"key": "jobName",
|
|
"value": "name1"
|
|
}
|
|
]
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="dli_02_0102__section57434560164325"><h4 class="sectiontitle">Example Response</h4><pre class="screen" id="dli_02_0102__screen44147025165546">{
|
|
"is_success": true,
|
|
"message": "",
|
|
"job_id": "8ecb0777-9c70-4529-9935-29ea0946039c",
|
|
"job_type": "DDL",
|
|
"job_mode":"sync",
|
|
"schema": [
|
|
{
|
|
"col_name": "string"
|
|
},
|
|
{
|
|
"data_type": "string"
|
|
},
|
|
{
|
|
"comment": "string"
|
|
}
|
|
],
|
|
"rows": [
|
|
[
|
|
"c1",
|
|
"int",
|
|
null
|
|
],
|
|
[
|
|
"c2",
|
|
"string",
|
|
null
|
|
]
|
|
]
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="dli_02_0102__sf39cfd445ad24e9e82754fcb0027179d"><h4 class="sectiontitle">Status Codes</h4><p id="dli_02_0102__a04144ca3a08e4576b386c6a98f43a2ae"><a href="#dli_02_0102__tb12870f1c5f24b27abd55ca24264af36">Table 6</a> describes status codes.</p>
|
|
|
|
<div class="tablenoborder"><a name="dli_02_0102__tb12870f1c5f24b27abd55ca24264af36"></a><a name="tb12870f1c5f24b27abd55ca24264af36"></a><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0102__tb12870f1c5f24b27abd55ca24264af36" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Status codes</caption><thead align="left"><tr id="dli_02_0102__r8d54231f95b14c01a5e55e95f3b2e838"><th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.7.3.2.3.1.1"><p id="dli_02_0102__ab49d21f312644072a331f43e92baf853">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="70%" id="mcps1.3.7.3.2.3.1.2"><p id="dli_02_0102__aea1d3bd107bb4c499da79a88832d256c">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0102__r211ad4eb571d4d938e5579998723174e"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0102__a3153e07b3a9749adba92599fe6628fbf">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0102__p104431642124811">Submitted successfully.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0102__row44937531727"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0102__p184941532219">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0102__p2049413539219">Request error.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0102__row14726424133719"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0102__p4726182423719">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0102__p1726424103720">Internal server error.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dli_02_0102__section13596141025715"><h4 class="sectiontitle">Error Codes</h4><p id="dli_02_0102__p420584425712">If an error occurs when this API is called, the system does not return the result similar to the preceding example, but returns an error code and error message. For details, see <a href="dli_02_0056.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="dli_02_0158.html">SQL Job-related APIs</a></div>
|
|
</div>
|
|
</div>
|
|
|