doc-exports/docs/dli/sqlreference/dli_spark_soundex.html
Su, Xiaomeng 76a5b1ee83 dli_sqlreference_20240227
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>
2024-03-27 22:02:33 +00:00

45 lines
4.2 KiB
HTML

<a name="dli_spark_soundex"></a><a name="dli_spark_soundex"></a>
<h1 class="topictitle1">soundex</h1>
<div id="body8662426"><p id="dli_spark_soundex__en-us_topic_0000001648099170_p1611917543309">This function is used to return the soundex string from <strong id="dli_spark_soundex__en-us_topic_0000001648099170_b1557615241199">str</strong>, for example, <strong id="dli_spark_soundex__en-us_topic_0000001648099170_b2180165919811">soundex('Miller') = M460</strong>.</p>
<div class="section" id="dli_spark_soundex__en-us_topic_0000001648099170_section45291954203217"><h4 class="sectiontitle">Syntax</h4><pre class="screen" id="dli_spark_soundex__en-us_topic_0000001648099170_screen1164981619226">soundex(string &lt;str&gt;)</pre>
</div>
<div class="section" id="dli_spark_soundex__en-us_topic_0000001648099170_section992014913317"><h4 class="sectiontitle">Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_spark_soundex__en-us_topic_0000001648099170_table1829154762513" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter</caption><thead align="left"><tr id="dli_spark_soundex__en-us_topic_0000001648099170_row8830104792517"><th align="left" class="cellrowborder" valign="top" width="19.220000000000002%" id="mcps1.3.3.2.2.5.1.1"><p id="dli_spark_soundex__en-us_topic_0000001648099170_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_soundex__en-us_topic_0000001648099170_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_soundex__en-us_topic_0000001648099170_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_soundex__en-us_topic_0000001648099170_p08301547132513">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dli_spark_soundex__en-us_topic_0000001648099170_row2826191220118"><td class="cellrowborder" valign="top" width="19.220000000000002%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_spark_soundex__en-us_topic_0000001648099170_p58771645125213">str</p>
</td>
<td class="cellrowborder" valign="top" width="13.420000000000002%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_spark_soundex__en-us_topic_0000001648099170_p14826312111113">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="15.590000000000002%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_spark_soundex__en-us_topic_0000001648099170_p18826101211118">STRING</p>
</td>
<td class="cellrowborder" valign="top" width="51.77%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_spark_soundex__en-us_topic_0000001648099170_p026862711252">String to be converted</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="dli_spark_soundex__en-us_topic_0000001648099170_section210162513312"><h4 class="sectiontitle">Return Values</h4><p id="dli_spark_soundex__en-us_topic_0000001648099170_p188481918104016">The return value is of the STRING type.</p>
<div class="note" id="dli_spark_soundex__en-us_topic_0000001648099170_note1542519149539"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="dli_spark_soundex__en-us_topic_0000001648099170_p14426131415535">If the value of <strong id="dli_spark_soundex__en-us_topic_0000001648099170_b9734954084350">str</strong> is <strong id="dli_spark_soundex__en-us_topic_0000001648099170_b20180697074350">NULL</strong>, <strong id="dli_spark_soundex__en-us_topic_0000001648099170_b2432243944350">NULL</strong> is returned.</p>
</div></div>
</div>
<div class="section" id="dli_spark_soundex__en-us_topic_0000001648099170_section13277192233920"><h4 class="sectiontitle">Example Code</h4><p id="dli_spark_soundex__en-us_topic_0000001648099170_p1573175682516">The value <strong id="dli_spark_soundex__en-us_topic_0000001648099170_b104741075102">M460</strong> is returned.</p>
<pre class="screen" id="dli_spark_soundex__en-us_topic_0000001648099170_screen18159126162612">SELECT soundex('Miller');</pre>
</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>