forked from docs/doc-exports
Su, Xiaomeng
57a0d535be
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>
353 lines
24 KiB
HTML
353 lines
24 KiB
HTML
<a name="dli_02_0033"></a><a name="dli_02_0033"></a>
|
|
|
|
<h1 class="topictitle1">Describing the Table Information</h1>
|
|
<div id="body8662426"><div class="section" id="dli_02_0033__s4d7af3a55ba34cc0ad39319579f69b71"><h4 class="sectiontitle">Function</h4><p id="dli_02_0033__en-us_topic_0069077903_p17176163">This API is used to describe metadata information in the specified table.</p>
|
|
</div>
|
|
<div class="section" id="dli_02_0033__s4d10c112744f4d8298e08964081970c4"><h4 class="sectiontitle">URI</h4><ul id="dli_02_0033__en-us_topic_0069077903_ul49091925"><li id="dli_02_0033__en-us_topic_0069077903_li39174147">URI format<p id="dli_02_0033__en-us_topic_0069077903_p17023004"><a name="dli_02_0033__en-us_topic_0069077903_li39174147"></a><a name="en-us_topic_0069077903_li39174147"></a>GET /v1.0/{project_id}/databases/{database_name}/tables/{table_name}</p>
|
|
</li><li id="dli_02_0033__li28611846132312">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0033__en-us_topic_0069077903_table18989315" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="dli_02_0033__en-us_topic_0069077903_row37144870"><th align="left" class="cellrowborder" valign="top" width="17.268273172682726%" id="mcps1.3.2.2.2.1.2.5.1.1"><p id="dli_02_0033__en-us_topic_0069077903_p621772417152">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="11.238876112388759%" id="mcps1.3.2.2.2.1.2.5.1.2"><p id="dli_02_0033__en-us_topic_0069077903_p721818240153">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.178582141785819%" id="mcps1.3.2.2.2.1.2.5.1.3"><p id="dli_02_0033__p1795422216270">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="57.31426857314268%" id="mcps1.3.2.2.2.1.2.5.1.4"><p id="dli_02_0033__a86c116e114d44f4c8e5ce60e82d3b11f">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0033__row18156104824111"><td class="cellrowborder" valign="top" width="17.268273172682726%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="dli_02_0033__en-us_topic_0069077803_p43412436">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.238876112388759%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="dli_02_0033__en-us_topic_0069077803_p26746391">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.178582141785819%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="dli_02_0033__p19553220277">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.31426857314268%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="dli_02_0033__p1310472724012">Project ID, which is used for resource isolation. For details about how to obtain its value, see <a href="dli_02_0183.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0033__en-us_topic_0069077903_row42334793"><td class="cellrowborder" valign="top" width="17.268273172682726%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="dli_02_0033__en-us_topic_0069077903_p6566175">database_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.238876112388759%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="dli_02_0033__en-us_topic_0069077903_p62098166">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.178582141785819%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="dli_02_0033__p159551322102711">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.31426857314268%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="dli_02_0033__p5938130183520">Name of the database where the target table resides.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0033__en-us_topic_0069077903_row38188964"><td class="cellrowborder" valign="top" width="17.268273172682726%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="dli_02_0033__en-us_topic_0069077903_p6298355">table_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.238876112388759%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="dli_02_0033__en-us_topic_0069077903_p40404735">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.178582141785819%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="dli_02_0033__p199551522172712">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.31426857314268%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="dli_02_0033__en-us_topic_0069077903_p51558063">Name of the target table.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dli_02_0033__sba3aea1255394b83a6b44b56d1443424"><h4 class="sectiontitle">Request</h4><p id="dli_02_0033__p41026741152339">None</p>
|
|
</div>
|
|
<div class="section" id="dli_02_0033__s3b91e8001c304b1fab9451feec878c3e"><h4 class="sectiontitle">Response</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0033__en-us_topic_0069077903_table27982971" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameters</caption><thead align="left"><tr id="dli_02_0033__en-us_topic_0069077903_row46534355"><th align="left" class="cellrowborder" valign="top" width="21.616161616161616%" id="mcps1.3.4.2.2.5.1.1"><p id="dli_02_0033__a8492bb7ea9aa47d1a50c3370cc8fd80c">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="11.404040404040403%" id="mcps1.3.4.2.2.5.1.2"><p id="dli_02_0033__aa391e61b7bee4dac8df4559b7910a81f">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18%" id="mcps1.3.4.2.2.5.1.3"><p id="dli_02_0033__ad5d73f500bd941708658fac31c1a15cb">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="48.97979797979798%" id="mcps1.3.4.2.2.5.1.4"><p id="dli_02_0033__en-us_topic_0069077903_p669144151612">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0033__en-us_topic_0069077903_row48222793"><td class="cellrowborder" valign="top" width="21.616161616161616%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0033__en-us_topic_0069077903_p13732189">is_success</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.404040404040403%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0033__en-us_topic_0069077903_p38565525">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0033__en-us_topic_0069077903_p36799834">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.97979797979798%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0033__p1096242814143">Indicates whether the request is successfully executed. Value <span class="parmvalue" id="dli_02_0033__parmvalue5716630816104"><b>true</b></span> indicates that the request is successfully executed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0033__en-us_topic_0069077903_row50642479"><td class="cellrowborder" valign="top" width="21.616161616161616%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0033__en-us_topic_0069077903_p8400114">message</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.404040404040403%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0033__en-us_topic_0069077903_p9320605">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0033__en-us_topic_0069077903_p16771545">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.97979797979798%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0033__p3962132820148">System prompt. If execution succeeds, the parameter setting may be left blank.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0033__en-us_topic_0069077903_row12643388"><td class="cellrowborder" valign="top" width="21.616161616161616%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0033__en-us_topic_0069077903_p17481528">column_count</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.404040404040403%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0033__en-us_topic_0069077903_p6717697">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0033__en-us_topic_0069077903_p7262590">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.97979797979798%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0033__en-us_topic_0069077903_p51398936">Total number of columns in the table.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0033__en-us_topic_0069077903_row59937243"><td class="cellrowborder" valign="top" width="21.616161616161616%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0033__en-us_topic_0069077903_p23078506">columns</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.404040404040403%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0033__en-us_topic_0069077903_p57419722">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0033__en-us_topic_0069077903_p20485923">Array of Objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.97979797979798%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0033__en-us_topic_0069077903_p48747036">Column information, including the column name, type, and description. For details, see <a href="#dli_02_0033__table12769172353815">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0033__row7659175314112"><td class="cellrowborder" valign="top" width="21.616161616161616%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0033__p9660155314117">table_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.404040404040403%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0033__p1866085316110">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0033__p156605531811">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.97979797979798%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0033__p126471208017">Table type. The options are as follows:</p>
|
|
<p id="dli_02_0033__p477415241007"><strong id="dli_02_0033__b85021048112210">MANAGED</strong>: DLI table</p>
|
|
<p id="dli_02_0033__p17416271011"><strong id="dli_02_0033__b729535114227">EXTERNAL</strong>: OBS table</p>
|
|
<p id="dli_02_0033__p56601531618"><strong id="dli_02_0033__b1132785442219">VIEW</strong>: view</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0033__row13425486312"><td class="cellrowborder" valign="top" width="21.616161616161616%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0033__p1042568933">data_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.404040404040403%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0033__p1742513818310">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0033__p14425208739">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.97979797979798%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0033__p134251481638">Data type, including <strong id="dli_02_0033__b587994181">CSV</strong>, <strong id="dli_02_0033__b2064720116189">Parquet</strong>, <strong id="dli_02_0033__b1411631414187">ORC</strong>, <strong id="dli_02_0033__b62732016201813">JSON</strong>, and <strong id="dli_02_0033__b26621420191815">Avro</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0033__row139671332836"><td class="cellrowborder" valign="top" width="21.616161616161616%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0033__p49679321233">data_location</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.404040404040403%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0033__p374855516512">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0033__p89671232235">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.97979797979798%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0033__p49678329311">Path for storing data, which is an OBS path.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0033__row169672320313"><td class="cellrowborder" valign="top" width="21.616161616161616%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0033__p796753219313">storage_properties</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.404040404040403%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0033__p149676328312">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0033__p1896716321633">Array of Objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.97979797979798%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0033__p1296720329315">Storage attribute, which is in the format of <strong id="dli_02_0033__b842352706103958">key/value</strong> and includes parameters <strong id="dli_02_0033__b842352706104011">delimiter</strong>, <strong id="dli_02_0033__b842352706104014">escape</strong>, <strong id="dli_02_0033__b842352706104017">quote</strong>, <strong id="dli_02_0033__b842352706104020">header</strong>, <strong id="dli_02_0033__b842352706104023">dateformat</strong>, and <strong id="dli_02_0033__b842352706104027">timestampformat</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0033__row1469733122110"><td class="cellrowborder" valign="top" width="21.616161616161616%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0033__p1870143310211">table_comment</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.404040404040403%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0033__p177016332215">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0033__p1570123342111">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.97979797979798%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0033__p670433102111">Table comment.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0033__row8702203742111"><td class="cellrowborder" valign="top" width="21.616161616161616%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0033__p97020373214">create_table_sql</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.404040404040403%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0033__p0702337162119">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0033__p13702193782120">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.97979797979798%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0033__p117022374214">Statement used to create a table.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="dli_02_0033__table12769172353815"></a><a name="table12769172353815"></a><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0033__table12769172353815" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="dli_02_0033__b1121313561916">columns</strong> parameters</caption><thead align="left"><tr id="dli_02_0033__row177016236386"><th align="left" class="cellrowborder" valign="top" width="21.616161616161616%" id="mcps1.3.4.3.2.5.1.1"><p id="dli_02_0033__p12770182310385">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="11.404040404040403%" id="mcps1.3.4.3.2.5.1.2"><p id="dli_02_0033__p8770142363817">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18%" id="mcps1.3.4.3.2.5.1.3"><p id="dli_02_0033__p14770152315385">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="48.97979797979798%" id="mcps1.3.4.3.2.5.1.4"><p id="dli_02_0033__p1177010234388">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0033__row877052393811"><td class="cellrowborder" valign="top" width="21.616161616161616%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0033__p18770102315385">column_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.404040404040403%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0033__p1077172316381">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0033__p167716230384">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.97979797979798%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0033__p877182373810">Column name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0033__row1771172311381"><td class="cellrowborder" valign="top" width="21.616161616161616%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0033__p18771823193819">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.404040404040403%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0033__p167716237387">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0033__p4771152333816">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.97979797979798%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0033__p13771623133817">Description of a column.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0033__row477142313386"><td class="cellrowborder" valign="top" width="21.616161616161616%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0033__p2077132353816">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.404040404040403%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0033__p877172313381">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0033__p17771223193815">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.97979797979798%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0033__p87711123133817">Data type of a column.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0033__row37711823113816"><td class="cellrowborder" valign="top" width="21.616161616161616%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0033__p10771162311383">is_partition_column</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.404040404040403%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0033__p57721523103814">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0033__p17729239381">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.97979797979798%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0033__p477222317385">Indicates whether the column is a partition column. The value <strong id="dli_02_0033__b132431650111512">true</strong> indicates that the column is a partition column, and the value <strong id="dli_02_0033__b8289105515153">false</strong> indicates that the column is not a partition column. The default value is <strong id="dli_02_0033__b79052019167">false</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dli_02_0033__section1835742415112"><h4 class="sectiontitle">Example Request</h4><p id="dli_02_0033__p810253431112">None</p>
|
|
</div>
|
|
<div class="section" id="dli_02_0033__section41378223152310"><h4 class="sectiontitle">Example Response</h4><ul id="dli_02_0033__ul10262191161620"><li id="dli_02_0033__li20461423131417"><strong id="dli_02_0033__b842352706104054_1">MANAGED</strong> type table<pre class="screen" id="dli_02_0033__screen1546223201412">{
|
|
"is_success": true,
|
|
"message": "",
|
|
"column_count": 3,
|
|
"columns": [
|
|
{
|
|
"column_name": "id",
|
|
"description": "",
|
|
"type": "int",
|
|
"is_partition_column": false
|
|
},
|
|
{
|
|
"column_name": "name",
|
|
"description": "",
|
|
"type": "string",
|
|
"is_partition_column": false
|
|
},
|
|
{
|
|
"column_name": "level",
|
|
"description": "",
|
|
"type": "string",
|
|
"is_partition_column": true
|
|
}
|
|
],
|
|
"table_type":"MANAGED"
|
|
}</pre>
|
|
</li><li id="dli_02_0033__li37764287169"><strong id="dli_02_0033__b84235270610410">EXTERNAL</strong> type table<pre class="screen" id="dli_02_0033__screen24602313146">{
|
|
"is_success": true,
|
|
"message": "",
|
|
"column_count": 2,
|
|
"columns": [
|
|
{
|
|
"type": "string",
|
|
"description": "",
|
|
"column_name": "col2",
|
|
"is_partition_column": false
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "",
|
|
"column_name": "col1",
|
|
"is_partition_column": true
|
|
}
|
|
],
|
|
"table_type": "EXTERNAL",
|
|
"data_type": "parquet",
|
|
"data_location": "obs://obs-wangtao/savepoint/savepoint-d95437-039668840fff/_metadata",
|
|
"storage_properties": [
|
|
{
|
|
"key": "timestampformat",
|
|
"value": "yyyy-MM-dd HH:mm:ss"
|
|
},
|
|
{
|
|
"key": "quote",
|
|
"value": "\""
|
|
},
|
|
{
|
|
"key": "dateformat",
|
|
"value": "yyyy-MM-dd"
|
|
},
|
|
{
|
|
"key": "escape",
|
|
"value": "\\"
|
|
},
|
|
{
|
|
"key": "header",
|
|
"value": "false"
|
|
},
|
|
{
|
|
"key": "delimiter",
|
|
"value": ","
|
|
}
|
|
],
|
|
"table_comment": "",
|
|
"create_table_sql": "CREATE TABLE `default`.`wan_test` (`col2` STRING, `col1` STRING)\nUSING parquet\nOPTIONS (\n `timestampformat` 'yyyy-MM-dd HH:mm:ss',\n `quote` '\"',\n `dateformat` 'yyyy-MM-dd',\n `escape` '\\\\',\n `header` 'false',\n `delimiter` ','\n)\nPARTITIONED BY (col1)\nCOMMENT ''\nLOCATION 'obs://obs-wangtao/savepoint/savepoint-d95437-039668840fff/_metadata'\nTBLPROPERTIES (\n 'hive.serialization.extend.nesting.levels' = 'true'\n)\n"
|
|
}</pre>
|
|
</li><li id="dli_02_0033__li382211343161"><strong id="dli_02_0033__b842352706104054_3">VIEW</strong> type table<pre class="screen" id="dli_02_0033__screen1955712391150">{
|
|
"is_success": true,
|
|
"message": "",
|
|
"column_count": 3,
|
|
"columns": [
|
|
{
|
|
"column_name": "id",
|
|
"description": "",
|
|
"type": "int",
|
|
"is_partition_column": false
|
|
},
|
|
{
|
|
"column_name": "name",
|
|
"description": "",
|
|
"type": "string",
|
|
"is_partition_column": false
|
|
},
|
|
{
|
|
"column_name": "level",
|
|
"description": "",
|
|
"type": "string",
|
|
"is_partition_column": true
|
|
}
|
|
],
|
|
"table_type":"VIEW",
|
|
"create_table_sql": "CREATE VIEW `default`.`view1`(id, name) AS\nselect * from a_gff.testtable\n"
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dli_02_0033__sf39cfd445ad24e9e82754fcb0027179d"><h4 class="sectiontitle">Status Codes</h4><p id="dli_02_0033__a04144ca3a08e4576b386c6a98f43a2ae"><a href="#dli_02_0033__tb12870f1c5f24b27abd55ca24264af36">Table 4</a> describes the status code.</p>
|
|
|
|
<div class="tablenoborder"><a name="dli_02_0033__tb12870f1c5f24b27abd55ca24264af36"></a><a name="tb12870f1c5f24b27abd55ca24264af36"></a><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0033__tb12870f1c5f24b27abd55ca24264af36" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Status codes</caption><thead align="left"><tr id="dli_02_0033__r8d54231f95b14c01a5e55e95f3b2e838"><th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.7.3.2.3.1.1"><p id="dli_02_0033__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_0033__aea1d3bd107bb4c499da79a88832d256c">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0033__r211ad4eb571d4d938e5579998723174e"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0033__a3153e07b3a9749adba92599fe6628fbf">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0033__p104431642124811">The operation is successful.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0033__row44937531727"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0033__p184941532219">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0033__p2049413539219">Request error.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0033__row65331212142411"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0033__p5537171216249">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0033__p953813124249">Internal service error.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dli_02_0033__section13596141025715"><h4 class="sectiontitle">Error Codes</h4><p id="dli_02_0033__p420584425712">If an error occurs when this API is invoked, the system does not return the result similar to the preceding example, but returns the error code and error information. 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_0031.html">Table-related APIs</a></div>
|
|
</div>
|
|
</div>
|
|
|