forked from docs/doc-exports
Su, Xiaomeng
76a5b1ee83
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>
59 lines
6.6 KiB
HTML
59 lines
6.6 KiB
HTML
<a name="dli_spark_encode"></a><a name="dli_spark_encode"></a>
|
|
|
|
<h1 class="topictitle1">encode</h1>
|
|
<div id="body8662426"><p id="dli_spark_encode__en-us_topic_0000001648099146_p18471163815215">This function is used to encode str in charset format.</p>
|
|
<div class="section" id="dli_spark_encode__en-us_topic_0000001648099146_section45291954203217"><h4 class="sectiontitle">Syntax</h4><p id="dli_spark_encode__en-us_topic_0000001648099146_p20212163319137">encode(string <str>, string <charset>)</p>
|
|
</div>
|
|
<div class="section" id="dli_spark_encode__en-us_topic_0000001648099146_section992014913317"><h4 class="sectiontitle">Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_spark_encode__en-us_topic_0000001648099146_table1829154762513" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters</caption><thead align="left"><tr id="dli_spark_encode__en-us_topic_0000001648099146_row8830104792517"><th align="left" class="cellrowborder" valign="top" width="19.220000000000002%" id="mcps1.3.3.2.2.5.1.1"><p id="dli_spark_encode__en-us_topic_0000001648099146_p983074711252">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13.420000000000002%" id="mcps1.3.3.2.2.5.1.2"><p id="dli_spark_encode__en-us_topic_0000001648099146_p6830124732517">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.590000000000002%" id="mcps1.3.3.2.2.5.1.3"><p id="dli_spark_encode__en-us_topic_0000001648099146_p13318164512614">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="51.77%" id="mcps1.3.3.2.2.5.1.4"><p id="dli_spark_encode__en-us_topic_0000001648099146_p08301547132513">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_spark_encode__en-us_topic_0000001648099146_row138881330152418"><td class="cellrowborder" valign="top" width="19.220000000000002%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_spark_encode__en-us_topic_0000001648099146_p15379143813245">str</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.420000000000002%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_spark_encode__en-us_topic_0000001648099146_p1937912389241">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.590000000000002%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_spark_encode__en-us_topic_0000001648099146_p183791038192411">STRING</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.77%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_spark_encode__en-us_topic_0000001648099146_p27431513256">At least two strings must be specified.</p>
|
|
<p id="dli_spark_encode__en-us_topic_0000001648099146_p19379638122412">The value is of the STRING type. If the value is of the BIGINT, DECIMAL, DOUBLE, or DATETIME type, the value is implicitly converted to the STRING type for calculation.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_spark_encode__en-us_topic_0000001648099146_row20280174932413"><td class="cellrowborder" valign="top" width="19.220000000000002%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_spark_encode__en-us_topic_0000001648099146_p15901133183217">charset</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.420000000000002%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_spark_encode__en-us_topic_0000001648099146_p1228018496242">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.590000000000002%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_spark_encode__en-us_topic_0000001648099146_p12191151811145">STRING</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.77%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_spark_encode__en-us_topic_0000001648099146_p8164136163315">Encoding format.</p>
|
|
<p id="dli_spark_encode__en-us_topic_0000001648099146_p13330205017325">The options are <strong id="dli_spark_encode__en-us_topic_0000001648099146_b15229195619480">UTF-8</strong>, <strong id="dli_spark_encode__en-us_topic_0000001648099146_b46679576482">UTF-16</strong>, <strong id="dli_spark_encode__en-us_topic_0000001648099146_b033745915486">UTF-16LE</strong>, <strong id="dli_spark_encode__en-us_topic_0000001648099146_b12772509494">UTF-16BE</strong>, <strong id="dli_spark_encode__en-us_topic_0000001648099146_b1778282124912">ISO-8859-1</strong>, and <strong id="dli_spark_encode__en-us_topic_0000001648099146_b88169915496">US-ASCII</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dli_spark_encode__en-us_topic_0000001648099146_section210162513312"><h4 class="sectiontitle">Return Values</h4><p id="dli_spark_encode__en-us_topic_0000001648099146_p9696151673319">The return value is of the BINARY type.</p>
|
|
<div class="note" id="dli_spark_encode__en-us_topic_0000001648099146_note61422099395"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="dli_spark_encode__en-us_topic_0000001648099146_p15430141203317">If the value of <strong id="dli_spark_encode__en-us_topic_0000001648099146_b515992210492">str</strong> or <strong id="dli_spark_encode__en-us_topic_0000001648099146_b1916032215499">charset</strong> is <strong id="dli_spark_encode__en-us_topic_0000001648099146_b111605224496">NULL</strong>, <strong id="dli_spark_encode__en-us_topic_0000001648099146_b1516122254919">NULL</strong> is returned.</p>
|
|
</div></div>
|
|
</div>
|
|
<div class="section" id="dli_spark_encode__en-us_topic_0000001648099146_section13277192233920"><h4 class="sectiontitle">Example Code</h4><ul id="dli_spark_encode__en-us_topic_0000001648099146_ul19860174173417"><li id="dli_spark_encode__en-us_topic_0000001648099146_li9860949349">Encodes string abc in UTF-8 format. An example command is as follows:<div class="p" id="dli_spark_encode__en-us_topic_0000001648099146_p13218204119"><a name="dli_spark_encode__en-us_topic_0000001648099146_li9860949349"></a><a name="en-us_topic_0000001648099146_li9860949349"></a>The value <strong id="dli_spark_encode__en-us_topic_0000001648099146_b19424618504">abc</strong> is returned.<pre class="screen" id="dli_spark_encode__en-us_topic_0000001648099146_screen2073913392014">select encode("abc", "UTF-8");</pre>
|
|
</div>
|
|
</li><li id="dli_spark_encode__en-us_topic_0000001648099146_li9860204103418">The value of any input parameter is <strong id="dli_spark_encode__en-us_topic_0000001648099146_b90891660863854">NULL</strong>. An example command is as follows:<p id="dli_spark_encode__en-us_topic_0000001648099146_p819011188211">The return value is <strong id="dli_spark_encode__en-us_topic_0000001648099146_b844723918504">NULL</strong>.</p>
|
|
<pre class="screen" id="dli_spark_encode__en-us_topic_0000001648099146_screen32296251528">select encode("abc", null);</pre>
|
|
</li></ul>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="dli_08_0472.html">String Functions</a></div>
|
|
</div>
|
|
</div>
|
|
|